Skip to main content
PATCH
Update a campaign

Authorizations

Authorization
string
header
required

Workspace API key, e.g. sa_live_…. Scopes: read / write / track / *.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Required range: x >= 1
attribution_model
enum<string>
Available options:
last_click,
first_click
status
enum<string>

Pausing stops tracking. Links stop crediting, and new referrals made while the campaign is paused earn nothing. Commissions on renewals from customers your affiliates already referred keep paying. The default campaign can't be paused: make another campaign the default first.

Available options:
active,
paused
join_mode
enum<string>

Who can join. anyone makes a membership active right away; approve means you approve each request; invite hides the campaign from affiliates outside it, who can't join or ask. You add people yourself, or auto_enrol adds them, and they're active. The default campaign can't be invite only. Wins over auto_approve when both are sent.

Available options:
anyone,
approve,
invite
auto_approve
boolean

Who can join. true lets anyone join; false means you approve each new affiliate. It decides signups while this is the default campaign, which is where new signups land, and on any campaign it decides whether an affiliate added automatically (auto_enrol) is active right away or waits for your approval. Omit to leave it unset (anyone).

auto_enrol
boolean

Add every new affiliate to this campaign automatically, on top of their main campaign. Turning it off removes no one.

add_existing
boolean
default:false

With auto_enrol true, also add your current affiliates now.

destination_url
string
ref_param
string

Response

Updated campaign

object
string
Example:

"campaign"

data
object