本文へ移動
Bounty Developer

POST/api/events/{slug}/manage/announce

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

要約

そのイベントの参加者へお知らせを送る（そのイベントの管理者だけ。宛先はそのイベントだけ）

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

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

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

  • slugpath必須string

送るもの（本文）application/json

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

  • title必須string
    長さ 1–40
  • body必須string
    長さ 1–140
  • link任意string
    長さ ≤200
  • audience必須object | object | object | object | object
  • |1必須object
  • kind必須"all"
  • |2必須object
  • kind必須"staff"
  • |3必須object
  • kind必須"session"
  • targetId必須string(uuid)
  • |4必須object
  • kind必須"booth"
  • targetId必須string(uuid)
  • |5必須object
  • kind必須"event"
  • targetId必須string(uuid)

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

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

  • sentinteger
  • labelstring

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 422HTTP 422（x-bounty-error-codes を参照）
  • 429HTTP 429（x-bounty-error-codes を参照）
  • invalid_origin
  • event_not_found
  • not_found
  • forbidden
  • manager_reverify_required
  • audience_outside_event
  • invalid_input
  • target_not_found
  • no_recipients
  • too_many_recipients
  • rate_limited

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/events/{slug}/manage/announce" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "string",
    "body": "string",
    "audience": {
      "kind": "all"
    }
  }'
POST /api/events/{slug}/manage/announce | Bounty Developer