Skip to main content
POST
Create bounty
This page documents the Legacy API. For new integrations, use Create Bounty in the Current API.
Required permissions:
  • bounty:create

Autorisaties

Authorization
string
header
vereist

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

bounty:create

Body

application/json

Parameters for CreateWorkforceBounty

base_unit_amount
number
vereist

The amount paid to each approved submission. The total bounty pool funded is this amount times accepted_submissions_limit, and must be at least 5 in the bounty's currency.

Voorbeeld:

6.9

currency
enum<string>
vereist

The currency for the bounty pool funding amount.

Beschikbare opties:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
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,
btc,
cny,
usdt,
kzt,
awg,
whop_usd,
xau,
hnl
description
string
vereist

The description of the bounty.

title
string
vereist

The title of the bounty.

accepted_submissions_limit
integer | null

The number of submissions that can be approved before the bounty closes. Defaults to 1. The total pool (base_unit_amount times this limit) must be at least 5 in the bounty's currency.

Voorbeeld:

42

allowed_country_codes
string[] | null

The ISO3166 country codes where this bounty should be visible. Empty means globally visible.

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

business_goal_type
enum<string> | null

What the poster is trying to accomplish with this bounty. Product taxonomy, distinct from the implementation type.

Beschikbare opties:
clipping,
post_engagement,
owned_account_growth,
ugc_content,
local_activation,
data_capture,
other
experience_id
string | null

An optional experience to scope the bounty to.

Voorbeeld:

"exp_xxxxxxxxxxxxxx"

minimum_total_verified_clip_duration_seconds
integer | null

Data capture bounties only: the minimum total server-verified clip duration in seconds. Defaults to 3600 and must be a whole number of hours between 1 and 12.

Voorbeeld:

42

origin_account_id
string | null

The user (user_) or company (biz_) tag whose balance funds this bounty pool. Defaults to the requester's personal balance when omitted. The requester must be the user themself or an owner/admin of the company.

post_markdown_content
string | null

Optional markdown body for the anchor forum post. Falls back to the bounty description when omitted.

post_title
string | null

Optional title for the anchor forum post. Falls back to the bounty title when omitted.

scheduled_frequency
enum<string> | null

How often a scheduled bounty republishes. Only applies when scheduled_publish_at is provided.

Beschikbare opties:
once,
hourly,
daily,
weekly,
monthly
scheduled_publish_at
string<date-time> | null

When to publish the bounty. When provided, the bounty is created as a hidden draft and published at this time instead of immediately. Must be in the future.

Voorbeeld:

"2023-12-01T05:00:00.401Z"

scheduled_timezone
string | null

The IANA timezone used for recurring occurrences. Required when scheduled_publish_at is provided.

Respons

A successful response

A privately accessible bounty.

bounty_type
enum<string>
vereist

The underlying bounty implementation type.

Beschikbare opties:
classic,
user_funded,
workforce
created_at
string<date-time>
vereist

The datetime the bounty was created.

Voorbeeld:

"2023-12-01T05:00:00.401Z"

currency
enum<string>
vereist

The currency used for the bounty funds.

Beschikbare opties:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
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,
btc,
cny,
usdt,
kzt,
awg,
whop_usd,
xau,
hnl
description
string
vereist

The description of the bounty.

id
string
vereist

The unique identifier for the bounty.

Voorbeeld:

"bnty_xxxxxxxxxxxxx"

status
enum<string>
vereist

The current lifecycle status of the bounty.

Beschikbare opties:
published,
archived,
scheduled
title
string
vereist

The title of the bounty.

total_available
number
vereist

The total amount currently funded in the bounty pool for payout.

Voorbeeld:

6.9

total_paid
number
vereist

The total amount paid out for this bounty.

Voorbeeld:

6.9

updated_at
string<date-time>
vereist

The datetime the bounty was last updated.

Voorbeeld:

"2023-12-01T05:00:00.401Z"

vote_threshold
integer
vereist

The number of watcher votes required before the submission can resolve.

Voorbeeld:

42