Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
Required range: x >= 1
attribution_model
enum<string>
default:last_click
Available options:
last_click,
first_click
status
enum<string>
default:active
Available options:
active,
paused,
archived
destination_url
string

Where referral links land (https). The dashboard requires this before a campaign can go live - API-created campaigns without it produce links with no landing page.

ref_param
string

Referral-link query parameter (e.g. via, ref, aff).

Response

Created campaign

object
string
Example:

"campaign"

data
object