本文へ移動

Bounty Developer

PATCH`/api/events/{slug}/manage/promo-codes/{codeId}`

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

要約: 札・上限・締切を直す・止める・再開する（コードと対象のチケットは変えない）
呼び方と印: ログイン

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

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

slugpath必須string
codeIdpath必須string(uuid)

送るもの（本文）application/json

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

label任意string
長さ ≤80
maxUses任意integer | null
closesAt任意string | null
長さ ≤40
stopped任意boolean

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

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

codeobject
- idstring(uuid)
- codestring
- labelstring
- ticketUniqueIdstring
- ticketNamestring
- maxUsesinteger | null
- closesAtstring | null
- stoppedAtstring | null
- usedinteger
- stateenum(5)"active" "stopped" "closed" "full" "sync_required"
- createdAtstring
- providerState任意string
- providerMessage任意string | null

失敗したとき（エラー）

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

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

event_not_found
forbidden
manager_reverify_required
not_found
human_action_required
invalid_input

呼び出しの見本

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

curl -X PATCH "https://bounty.spikes.4s.link/api/events/{slug}/manage/promo-codes/{codeId}" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{}'

PATCH /api/events/{slug}/manage/promo-codes/{codeId} | Bounty Developer