Skip to main content
POST
Send a custom bonus

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Path Parameters

id
string
required

The id.

Body

application/json

Send a wallet-funded, arbitrary-amount bonus to a creator. Moves real money from the company wallet.

creatorId
string
required

The creator id to pay the bonus to.

amount
number
required

Bonus amount in USD dollars (e.g. 50 = $50.00). Must be positive and not exceed $10,000.

Required range: x <= 10000
notes
string
required

Required description of the commercial obligation and completed work.

Required string length: 10 - 500
programId
string

Optional campaign (program) id to attribute the bonus to.

Response

The custom bonus was sent.

data
object
required

Result of sending a custom bonus. Amounts marked USD are dollars; amounts marked Cents are integer cents.