Create bounty

Create a new workforce bounty by funding a dedicated bounty pool.

Required permissions:

• bounty:create

POST /bounties

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const bounty = await client.bounties.create({
  base_unit_amount: 6.9,
  currency: 'usd',
  description: 'description',
  title: 'title',
});

console.log(bounty.id);

200

{
  "id": "bnty_xxxxxxxxxxxxx",
  "title": "<string>",
  "description": "<string>",
  "total_available": 6.9,
  "total_paid": 6.9,
  "vote_threshold": 42,
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z"
}

Authorizations

Authorization · string · header · required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Body

application/json

Parameters for CreateWorkforceBounty

base_unit_amount · number · required

The amount paid to each approved submission. The total bounty pool funded is this amount times accepted_submissions_limit.

Example:

6.9

currency · enum<string> · required

The currency for the bounty pool funding amount.

Available options: 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

description · string · required

The description of the bounty.

title · string · required

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.

Example:

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.

experience_id · string | null

An optional experience to scope the bounty to.

Example:

"exp_xxxxxxxxxxxxxx"

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.

Response

200

application/json

A successful response

A privately accessible bounty.

id · string · required

The unique identifier for the bounty.

Example:

"bnty_xxxxxxxxxxxxx"

title · string · required

The title of the bounty.

description · string · required

The description of the bounty.

status · enum<string> · required

The current lifecycle status of the bounty.

Available options: published, archived

total_available · number · required

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

Example:

6.9

total_paid · number · required

The total amount paid out for this bounty.

Example:

6.9

currency · enum<string> · required

The currency used for the bounty funds.

Available options: 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

bounty_type · enum<string> · required

The underlying bounty implementation type.

Available options: classic, user_funded, workforce

vote_threshold · integer · required

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

Example:

42

created_at · string<date-time> · required

The datetime the bounty was created.

Example:

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

updated_at · string<date-time> · required

The datetime the bounty was last updated.

Example:

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