Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Use API key as Bearer token, for example: Bearer ak_live_xxx

Headers

Idempotency-Key
string

Client generated idempotency key (recommended for create/financial operations).

Body

application/json
name
string
required
Required string length: 1 - 100
commissionType
enum<string>
required
Available options:
one_time,
recurring,
recurring_limited
commissionPercent
number
required
Required range: 1 <= x <= 100
description
string
Maximum string length: 500
website
string<uri>
landingPageUrl
string<uri>
commissionLimitMonths
number
Required range: 1 <= x <= 36
Required range: 1 <= x <= 365
payoutThreshold
number
Required range: 1000 <= x <= 100000
payoutFrequency
enum<string>
Available options:
weekly,
monthly,
quarterly
marketplaceStatus
enum<string>
Available options:
private,
draft,
public
applicationAccess
enum<string>
Available options:
open,
invite_only
marketplaceCategory
string
Maximum string length: 64
marketplaceDescription
string
Maximum string length: 500
marketplaceLogoUrl
string<uri>
autoApproveAffiliates
boolean
portalSlug
string
Required string length: 3 - 63
Pattern: ^[a-z0-9-]+$
currency
string
Required string length: 3 - 5

Response

Program created

data
object
required
meta
object
required