本文へ移動
Bounty Developer

DELETE/api/planning/blocks/{contentId}

「コンテンツ企画」の分類の、対象を消す・外す・取り消す API。ブラウザでログインした本人(cookie)として呼ぶ。

要約

下書きのコンテンツを消す(一度でも公開したもの・募集が結んであるもの・出展者が属するもの・チャットのあるものは 409。ブラウザのログインだけ)

呼び方と印

ログイン(cookie)・レート制限

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

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

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

  • contentIdpath必須string(uuid)

返るもの(応答)200 · application/json

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

  • oktrue
  • revinteger≥0

失敗したとき(エラー)

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

  • 400入力の誤り(error = invalid_input など)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403権限が無い
  • 404HTTP 404(x-bounty-error-codes を参照)
  • 409HTTP 409(x-bounty-error-codes を参照)
  • 428HTTP 428(x-bounty-error-codes を参照)
  • 429レート制限(Retry-After 付き)
  • unauthorized
  • forbidden
  • invalid_origin
  • consent_required
  • session_required
  • content_not_found
  • content_published
  • content_in_use

呼び出しの見本

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

curl -X DELETE "https://bounty.spikes.4s.link/api/planning/blocks/{contentId}" \
  -b "bounty_session=$COOKIE_AUTH"
DELETE /api/planning/blocks/{contentId} | Bounty Developer