本文へ移動

Bounty Developer

PATCH`/api/companies/{id}`

「企業ページ」の分類の、対象のうち、送った項目だけを直す API。ログインした本人として呼ぶ。

要約: 会社の紹介・ロゴ・公開の設定を直す（会社の管理者か運営 admin）
呼び方と印: ログイン

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

idpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

name必須string
長さ 1–120
slug必須string
/^[a-z0-9-]{1,100}$/
description必須string | null
長さ ≤200
logoUrl必須string | null
長さ ≤2048
logoImageId任意string(uuid) | null
darkLogoUrl任意string | null
長さ ≤2048
darkLogoImageId任意string(uuid) | null
isPublic任意boolean
website必須string | null
長さ ≤2048
foursOrgId必須string | null
長さ ≤100
expectedRevision任意integer
≥0

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

idstring
namestring
slugstring
descriptionstring | null
logoUrlstring | null
logoImageIdstring | null
websitestring | null
foursOrgIdstring | null
isPublicboolean
darkLogoUrlstring | null
darkLogoImageIdstring | null
revisioninteger
createdAtstring
updatedAtstring
joinLink任意object
- urlstring
- expiresAtstring

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

400入力の誤り（error = invalid_input など）
401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
403権限が無い
404HTTP 404（x-bounty-error-codes を参照）
409HTTP 409（x-bounty-error-codes を参照）
413HTTP 413（x-bounty-error-codes を参照）
415HTTP 415（x-bounty-error-codes を参照）

invalid_origin
unsupported_media_type
forbidden
company_not_found
event_manager_required
identity_locked
company_exists
image_not_found

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl -X PATCH "https://bounty.spikes.4s.link/api/companies/{id}" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "slug": "string",
    "description": "string",
    "logoUrl": "string",
    "website": "string",
    "foursOrgId": "string"
  }'

PATCH /api/companies/{id} | Bounty Developer