本文へ移動
Bounty Developer

POST/api/companies/{id}/member-drafts/preview

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

要約

メンバー下書き（50 件まで）を検証（書込みなし）

呼び方と印

ログイン・レート制限

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

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

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

  • idpath必須string(uuid)

送るもの（本文）application/json

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

  • items必須array<object>
    件数 1–50
  • sourceKey必須string
    /^[A-Za-z0-9][A-Za-z0-9_.:-]{0,79}$/
  • displayName必須string
    長さ 1–60
  • title任意string
    長さ ≤40
  • bio任意string
    長さ ≤400
  • catchphrase任意string
    長さ ≤60
  • links任意record<string>
  • recipientNote任意string
    長さ ≤120

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

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

  • companyIdstring(uuid)
  • itemsarray<object>件数 ≤50
    • sourceKeystring
    • displayNamestring
    • filledarray<"title" | "bio" | "catchphrase" | "links">件数 ≤4
    • action"create" | "update" | "skip_closed"
  • publication"draft_only"
  • writes0

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の 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 を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • 500HTTP 500（x-bounty-error-codes を参照）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • forbidden
  • invalid_token
  • consent_required
  • company_not_found
  • member_draft_limit
  • invalid_input

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/companies/{id}/member-drafts/preview" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "sourceKey": "string",
        "displayName": "string"
      }
    ]
  }'
POST /api/companies/{id}/member-drafts/preview | Bounty Developer