本文へ移動
Bounty Developer

DELETE/api/boshu/contact

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

要約

本人が募集連絡先を解除し未送信メールを停止する

呼び方と印

ログイン

送るもの(本文)application/json

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

  • currentRevision必須integer
    ≥0

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

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

  • revisioninteger≥0
  • verifiedboolean
  • suppressedboolean
  • maskedEmailstring | null
  • digestEnabledboolean
  • configuredboolean
  • pendingChallengeIdstring(uuid) | null
  • pendingExpiresAtstring(date-time) | null

失敗したとき(エラー)

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

  • 400HTTP 400(x-bounty-error-codes を参照)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403HTTP 403(x-bounty-error-codes を参照)
  • 409HTTP 409(x-bounty-error-codes を参照)
  • 413HTTP 413(x-bounty-error-codes を参照)
  • 428HTTP 428(x-bounty-error-codes を参照)
  • invalid_input
  • human_action_required
  • contact_changed
  • consent_required

呼び出しの見本

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

curl -X DELETE "https://bounty.spikes.4s.link/api/boshu/contact" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "currentRevision": 0
  }'
DELETE /api/boshu/contact | Bounty Developer