本文へ移動
Bounty Developer

PATCH/api/orgs/members/{id}

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

要約

メンバーを直す（役職・肩書き・次期・権限・在籍の年・卒業予定の年・在籍の終わり。名前はアカウントに結び付く前だけ）

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

送るもの（本文）application/json

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

  • role任意string
    長さ 1–20
  • title任意string | null
    長さ ≤40
  • term任意"current" | "next"
  • termNumber任意integer | null
    1–999
  • access任意"owner" | "admin" | "editor" | "viewer"
  • joinedYear任意integer | null
    1950–2100
  • leftYear任意integer | null
    1950–2100
  • endReason任意"graduated" | "retired" | "withdrawn" | null
  • gradYear任意integer | null
    1950–2100
  • name任意string
    長さ 1–40
  • school任意string | null
    長さ ≤80
  • instagram任意string | null
    長さ ≤2048
  • end任意boolean

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

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

  • oktrue

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • org_forbidden
  • access_forbidden
  • last_owner
  • invalid_role
  • member_linked

呼び出しの見本

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

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