v8

OpenAPI 3.1.02026-08-033623795.0 MB

Bounties

Cancel

Cancels a bounty. With no in-flight work, it cancels immediately and refunds the funder. Otherwise it stops new submissions and cancels once the in-flight work resolves and pays out. Repeating the request is a no-op. A bounty that already paid out every slot returns 400.

post/bounties/{id}/cancel

Headers

Idempotency-Keystring

Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Response

cancellation requested

accepted_deliverable_typesstring[] required

accepted_submissions_countinteger required

Submissions accepted so far.

accepted_submissions_limitinteger required

Number of submissions that can be accepted (winner slots).

allowed_country_codesstring[] required

budget_amountnumber required

Total gross budget committed to the bounty: gross_reward_amount times accepted_submissions_limit.

What the poster wants the work to achieve, declared once at create. null for bounties created before the taxonomy rolled out.

cancel_requested_atstring nullable required

When cancellation was requested, as an ISO 8601 timestamp. On a closed bounty this means the cancel is pending: submissions are stopped and the bounty cancels once in-flight submissions resolve. On a canceled bounty it records when the cancellation was requested. null when no cancellation was ever requested.

created_atstring required

When the bounty was created, as an ISO 8601 timestamp.

currency'usd' | 'sgd' | 'inr' | 'aud' | 'brl' | 'cad' | 'dkk' | 'eur' | 'nok' | 'gbp' | 'sek' | 'chf' | 'hkd' | 'huf' | 'jpy' | 'mxn' | 'myr' | 'pln' | 'czk' | 'nzd' | 'aed' | 'cop' | 'ron' | 'thb' | 'bgn' | 'idr' | 'dop' | 'php' | 'try' | 'krw' | 'twd' | 'vnd' | 'pkr' | 'clp' | 'uyu' | 'ars' | 'zar' | 'dzd' | 'tnd' | 'mad' | 'kes' | 'kwd' | 'jod' | 'all' | 'xcd' | 'amd' | 'bsd' | 'bhd' | 'bob' | 'bam' | 'khr' | 'crc' | 'xof' | 'egp' | 'etb' | 'gmd' | 'ghs' | 'gtq' | 'gyd' | 'ils' | 'jmd' | 'mop' | 'mga' | 'mur' | 'mdl' | 'mnt' | 'nad' | 'ngn' | 'mkd' | 'omr' | 'pyg' | 'pen' | 'qar' | 'rwf' | 'sar' | 'rsd' | 'lkr' | 'tzs' | 'ttd' | 'uzs' | 'rub' | 'cny' | 'kzt' | 'awg' required

Currency for all amounts on the bounty, as a lowercase ISO 4217 code.

descriptionstring required

Full task instructions shown to workers.

experience_idstring nullable required

Experience the bounty is hosted in, prefixed exp_. null for platform-wide bounties; may belong to a different account than the funder.

gross_paid_out_amountnumber required

Gross amount paid out from the bounty pool across accepted submissions — worker payouts, platform fees, and affiliate shares together. Tips and reviewer rewards are excluded.

gross_reward_amountnumber required

Gross bounty-pool amount allocated per accepted submission, in whole currency units.

idstring required

Bounty ID, prefixed bnty_.

How often the schedule creates a new bounty. Each occurrence is a separate bounty; the original is not republished.

scheduled_publish_atstring nullable required

When a scheduled bounty will publish, as an ISO 8601 timestamp. null once published, for bounties that were never scheduled, and for terminally failed drafts parked for manual rescheduling.

spots_remaininginteger required

Unfilled winner capacity: accepted_submissions_limit minus accepted_submissions_count, clamped to zero. Not a signal that the bounty currently accepts new claims.

status'scheduled' | 'open' | 'closed' | 'completed' | 'canceled' required

Lifecycle state. scheduled bounties are unpublished drafts, visible to their poster and the account's authorized managers; open bounties accept new submissions; closed bounties are live but no longer accept new submissions; completed bounties paid out every winner slot; canceled bounties ended before filling their slots.

submissions_closed_atstring nullable required

When new submissions stopped being accepted, as an ISO 8601 timestamp. Set when a cancellation is requested on a bounty with work in flight, so in-flight submissions can resolve before the bounty cancels. null when submissions were never stopped — including completed bounties that simply filled every winner slot.

titlestring required

Short name of the task shown to workers.

unresolved_submissions_countinteger required

Submissions still awaiting an outcome: in progress or pending review.

updated_atstring required

When the bounty was last updated, as an ISO 8601 timestamp.

Example response

{
  "accepted_deliverable_types": [
    "content_url"
  ],
  "business_goal_type": "clipping",
  "capture_spec": {
    "video": {
      "stabilization_mode": "off"
    }
  },
  "currency": "usd",
  "scheduled_frequency": "once",
  "status": "scheduled"
}