POST/api/orgs/logo-variants/{id}
「学生団体・ベンチャー」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。
- 要約
ロゴ版の用途・主ロゴ・解除を更新(revision照合・本人編集権限)
- 呼び方と印
ログイン・レート制限
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
URL に付ける値(パラメータ)
経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。
idpath必須string(uuid)
送るもの(本文)application/json
送る本文の欄。「必須」の印がある欄は省けない。
|1必須objectaction必須"remove"expectedRevision必須integer0–2147483646confirmed必須true|2必須objectaction必須"primary"expectedPrimaryImageId必須string(uuid) | nullexpectedRevision必須integer0–2147483646|3必須objectaction必須"edit"expectedRevision必須integer0–2147483646purpose必須"square" | "wordmark" | "light" | "dark"label必須string長さ ≤60
返るもの(応答)200 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
oktrueimage任意objectidstring(uuid)urlstring
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400HTTP 400(x-bounty-error-codes を参照)
- 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
- 403HTTP 403(x-bounty-error-codes を参照)
- 404HTTP 404(x-bounty-error-codes を参照)
- 409HTTP 409(x-bounty-error-codes を参照)
- 413HTTP 413(x-bounty-error-codes を参照)
- 415HTTP 415(x-bounty-error-codes を参照)
- 428HTTP 428(x-bounty-error-codes を参照)
- 429レート制限(Retry-After 付き)
- 503HTTP 503(x-bounty-error-codes を参照)
- org_forbidden
- org_not_found
- logo_variant_not_found
- logo_variant_limit
- logo_variant_invalid
- revision_conflict
- image_not_found
- invalid_input
- invalid_origin
- multipart_required
- invalid_multipart
- file_required
- empty_file
- image_too_large
- unsupported_image
- invalid_image
- svg_too_large
- svg_dimensions_invalid
- storage_not_configured
- guild_synced
- consent_required
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X POST "https://bounty.spikes.4s.link/api/orgs/logo-variants/{id}" \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "Content-Type: application/json" \
-d '{
"action": "remove",
"expectedRevision": 0,
"confirmed": true
}'