本文へ移動
Bounty Developer

POST/api/events/{slug}/manage/promo-codes

「イベント」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約

プロモーションコードを作る(コード・札・対象の 4S のチケットの uniqueId・上限・締切。基準のチケットから専用の4Sチケットを作り同期する)

呼び方と印

ログイン

URL に付ける値(パラメータ)

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

  • slugpath必須string

送るもの(本文)application/json

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

  • code必須string
    長さ ≤48
  • label必須string
    長さ ≤80
  • ticketUniqueId必須string
    長さ 1–100
  • maxUses必須integer | null
  • closesAt必須string | null
    長さ ≤40

返るもの(応答)201 · 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権限が無い
  • 409HTTP 409(x-bounty-error-codes を参照)
  • event_not_found
  • forbidden
  • manager_reverify_required
  • not_found
  • human_action_required
  • invalid_input
  • promotion_ticket_unavailable
  • promotion_code_taken

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/events/{slug}/manage/promo-codes" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "string",
    "label": "string",
    "ticketUniqueId": "string",
    "maxUses": -9007199254740991,
    "closesAt": "string"
  }'
POST /api/events/{slug}/manage/promo-codes | Bounty Developer