Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Required string length: 1 - 100
description
string
Maximum string length: 500
website
string<uri>
landingPageUrl
string<uri>
status
enum<string>
Available options:
active,
paused,
archived
commissionType
enum<string>
Available options:
one_time,
recurring,
recurring_limited
commissionPercent
number
Required range: 1 <= x <= 100
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
applicationAccess
enum<string>
Available options:
open,
invite_only
autoApproveAffiliates
boolean
portalSlug
string | null
Required string length: 3 - 63
Pattern: ^[a-z0-9-]+$
currency
string
Required string length: 3 - 5

Response

Updated program

data
object
required
meta
object
required