本文へ移動
Bounty Developer

PATCH/api/orgs/guilds/{id}

「学生団体・ベンチャー」の分類の、対象のうち、送った項目だけを直す API。ログインした本人として呼ぶ。

要約

ギルドの紹介を直す（編集の権限以上か運営）

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

送るもの（本文）application/json

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

  • basicProfile任意object
  • nameKana任意string | null
    長さ ≤240
  • organizationType任意string | null
    長さ ≤80
  • baseUniversities任意array<string>
    件数 ≤20
  • foundedYearMonth任意string | null
    /^(19[5-9]\d|20\d\d|2100)-(0[1-9]|1[0-2])$/
  • studentMemberCount任意integer | null
    0–100000
  • activitySummary任意string | null
    長さ ≤2000
  • catchphrase任意string | null
    長さ ≤40
  • name任意string
    長さ 1–80
  • description任意string
    長さ 1–400
  • links任意array<object>
    件数 ≤18
  • kind必須enum(8)
    • "website"
    • "x"
    • "instagram"
    • "youtube"
    • "tiktok"
    • "facebook"
    • "note"
    • "discord"
  • url必須string
    長さ ≤2048
  • title任意string
    長さ ≥1
  • memberCount任意integer | null
    1–100000
  • genres任意array<enum(38)>
    件数 ≤38
  • areas任意array<enum(47)>
    件数 ≤8
  • logoImageId任意string(uuid) | null
  • media任意array<object>
    件数 ≤12
  • kind必須"image" | "youtube" | "vimeo"
  • imageId任意string(uuid) | null
  • url任意string | null
    長さ ≤2000
  • title任意string | null
    長さ ≤120
  • coverImageId任意string(uuid) | null
  • works任意array<object>
    件数 ≤24
  • id必須string
    /^w_[a-z0-9]{4,24}$/
  • title必須string
    長さ 1–60
  • url任意string | null
    長さ ≤2048
  • imageId任意string(uuid) | null
  • text任意string | null
    長さ ≤200
  • year任意integer | null
    1950–2100
  • universityCode任意string | null
    /^[A-Z0-9]{4,16}$/
  • universityName任意string | null
    長さ ≤80

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

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

  • oktrue

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の 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 を参照）
  • guild_not_found
  • org_forbidden
  • guild_synced
  • org_image_not_found
  • org_image_forbidden

呼び出しの見本

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

curl -X PATCH "https://bounty.spikes.4s.link/api/orgs/guilds/{id}" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{}'
PATCH /api/orgs/guilds/{id} | Bounty Developer