Skip to main content
POST
/
programs
Error
A valid request URL is required to generate request examples
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "slug": "<string>",
    "website": "<string>",
    "landingPageUrl": "<string>",
    "portalSlug": "<string>",
    "marketplaceStatus": "private",
    "applicationAccess": "open",
    "marketplaceCategory": "<string>",
    "marketplaceDescription": "<string>",
    "marketplaceLogoUrl": "<string>",
    "commissionPercent": 123,
    "commissionLimitMonths": 123,
    "commissionHoldDays": 123,
    "cookieDuration": 123,
    "trackingRequiresConsent": true,
    "trackingParamAliases": [
      "<string>"
    ],
    "payoutThreshold": 123,
    "currency": "<string>",
    "autoApproveAffiliates": false,
    "termsUrl": "<string>",
    "stripeAccountId": "<string>",
    "stripeAccountDisplayName": "<string>",
    "stripeConnectedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "<string>"
  }
}

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
​
cookieDuration
number
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