Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

Use your API secret as the username, with an empty password.

Body

application/json
name
string
required
url
string
required
reward_type
enum<string>
Available options:
percent,
amount
commission_percent
number
commission_amount_cents
integer
days_before_referrals_expire
integer
minimum_payout_cents
integer
max_commission_period_in_months
integer

Response

201 - application/json

Created

id
string
object
string
Example:

"campaign"

created_at
string<date-time>
updated_at
string<date-time>
name
string
url
string
private
boolean
reward_type
enum<string>
Available options:
percent,
amount
commission_percent
number | null
commission_amount_cents
integer | null
commission_currency
string
minimum_payout_cents
integer
days_before_referrals_expire
integer
days_before_commissions_are_due
integer
max_commissions
integer | null
max_commission_period_in_months
integer | null