POST/api/orgs/ventures/{id}/members
「学生団体・ベンチャー」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。
- 要約
学生発ベンチャーのメンバー(キーマン・社員)を招待する
- 呼び方と印
ログイン
URL に付ける値(パラメータ)
経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。
idpath必須string(uuid)
送るもの(本文)application/json
送る本文の欄。「必須」の印がある欄は省けない。
userId任意string(uuid) | nullname任意string | null長さ ≤40email任意string(email) | null長さ ≤254role必須string長さ 1–20title任意string | null長さ ≤40term任意"current" | "next"既定 "current"termNumber任意integer | null1–999access任意"owner" | "admin" | "editor" | "viewer"既定 "viewer"joinedYear任意integer | null1950–2100student任意boolean | null
返るもの(応答)201 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
memberIdstringinviteUrlstring | null
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
- 403権限が無い
- org_forbidden
- invalid_role
- access_forbidden
- already_member
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X POST "https://bounty.spikes.4s.link/api/orgs/ventures/{id}/members" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{
"role": "string"
}'