本文へ移動
Bounty Developer

DELETE/api/events/{slug}/manage/questionnaires/{questionnaireId}/pages/{pageId}/modules/{refId}

「イベント」の分類の、対象を消す・外す・取り消す API。ログインした本人として呼ぶ。

要約

下書きのページからモジュールを外す（共通モジュールそのものは残る。公開版は固定のまま）

呼び方と印

ログイン

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

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

  • slugpath必須string
  • questionnaireIdpath必須string(uuid)
  • pageIdpath必須string
  • refIdpath必須string

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

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

  • draftobject
    • pagesarray<object>件数 ≤3
      • idstring/^p_[a-z0-9]{4,24}$/
      • destination"fours_common" | "bounty_profile" | "bounty_event"
      • placement"before_checkout" | "after_checkout"
      • titlestring長さ 1–80
      • modulesarray<object | object>件数 ≤20
        • |1object
          • kind"shared"
          • idstring/^mr_[a-z0-9]{4,24}$/
          • moduleIdstring(uuid)
        • |2object
          • kind"inline"
          • idstring/^mr_[a-z0-9]{4,24}$/
          • bodyobject
            • titlestring長さ 1–80
            • helpany
            • questionsarray<any>件数 1–30

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 409HTTP 409（x-bounty-error-codes を参照）
  • event_not_found
  • feature_disabled
  • forbidden
  • manager_reverify_required
  • human_action_required
  • invalid_input
  • questionnaire_not_found
  • questionnaire_archived
  • page_not_found
  • module_not_found

呼び出しの見本

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

curl -X DELETE "https://bounty.spikes.4s.link/api/events/{slug}/manage/questionnaires/{questionnaireId}/pages/{pageId}/modules/{refId}" \
  -H "Authorization: Bearer $BEARER_AUTH"
DELETE /api/events/{slug}/manage/questionnaires/{questionnaireId}/pages/{pageId}/modules/{refId} | Bounty Developer