本文へ移動
Bounty Developer

PATCH/api/boshu/calls/{id}

「BOSHU の管理」の分類の、対象のうち、送った項目だけを直す API。ログインした本人として呼ぶ。

要約

募集を直す(持ち主の管理者・運営。承認済みのギルド・学生発ベンチャーの募集の中身を変えると承認待ちへ戻る)

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

送るもの(本文)application/json

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

  • signupPolicy任意"required" | "optional"
  • ticketOffer任意boolean
  • groupSubmissionPolicy任意"managers" | "confirmed_members"
  • defaultMailPreviewHash任意string
    /^[a-f0-9]{64}$/
  • applicantKind任意"individual" | "guild" | "venture"
  • template任意enum(10) | null
    • "member"
    • "talk"
    • "pitch"
    • "hackathon"
    • "student_guild"
    • "student_venture"
    • "guild_royale"
    • "creative_blitz"
    • "open_meeting"
    • "partner"
  • profilePolicy任意"kind" | "required" | "basic"
  • portfolioRequired任意boolean
  • messagePolicy任意"legacy" | "required" | "optional" | "off"
  • applicationFields任意object | null
  • headline任意object
  • enabled必須boolean
  • required必須boolean
  • label必須string
    長さ 1–120
  • placeholder必須string
    長さ ≤200
  • message任意object
  • enabled必須boolean
  • required必須boolean
  • label必須string
    長さ 1–120
  • placeholder必須string
    長さ ≤200
  • links任意object
  • enabled必須boolean
  • required必須boolean
  • label必須string
    長さ 1–120
  • placeholder必須string
    長さ ≤200
  • portfolio任意object
  • enabled必須boolean
  • required必須boolean
  • label必須string
    長さ 1–120
  • placeholder必須string
    長さ ≤200
  • contentId任意string(uuid) | null
  • keyVisualUploadId任意string(uuid) | null
  • audience任意"all" | "student" | "professional"
  • kind任意"staff" | "talk" | "pitch" | "other"
  • title任意string
    長さ 1–60
  • description任意string | null
    長さ ≤2000
  • requirements任意string | null
    長さ ≤600
  • sessionId任意string(uuid) | null
  • capacity任意integer | null
    1–500
  • talkMinutes任意integer | null
    1–120
  • opensAt任意string
  • closesAt任意string
  • mode任意"review" | "first_come"
  • paid任意boolean
  • compensation任意string | null
    長さ ≤120
  • ribbonLabel任意string | null
    長さ ≤16
  • status任意"draft" | "published" | "closed"

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

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

  • callobject | null
    • idstring
    • kind"staff" | "talk" | "pitch" | "other"
    • status"draft" | "published" | "closed"
    • titlestring
    • sessionIdstring | null
    • capacityinteger | null
    • talkMinutesinteger | null
    • opensAtstring
    • closesAtstring
    • phase"hidden" | "upcoming" | "open" | "closed"
    • paidboolean
    • compensationstring | null
    • announcedAtstring | null
    • externalobject | null
      • sourcestring
      • idstring
    • ownerOrgIdstring | null
    • ownerEventIdstring | null
    • ownerobject
      • kindenum(5)"platform" "event" "guild" "venture" "person"
      • idstring | null
      • namestring
      • hrefstring | null
    • approval"not_required" | "pending" | "approved" | "rejected"
    • countsobject
      • pendinginteger
      • holdinteger
      • acceptedinteger
      • waitlistedinteger
      • rejectedinteger
      • withdrawninteger
    • unnotifiedinteger
    • questionCountinteger

失敗したとき(エラー)

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

  • 400入力の誤り(error = invalid_input など)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403権限が無い
  • call_not_found
  • invalid_input
  • invalid_time_range
  • kind_locked
  • capacity_below_accepted
  • session_not_allowed
  • manager_reverify_required

呼び出しの見本

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

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