Skip to main content
POST
Create campaign

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
name
string
required

Campaign name. Maximum 100 characters.

affiliate_id
integer
required

ID of the affiliate this campaign belongs to. Must be within the caller's visibility scope.

offer_id
integer
required

ID of an active offer. Must be accessible to the selected affiliate.

landing_page_id
integer
required

ID of an active landing page belonging to the selected offer.

traffic_source_id
integer

Optional traffic source ID.

traffic_approach_id
integer

Optional traffic approach ID.

creative_id
integer | null

Optional creative ID belonging to the selected offer.

status
enum<string>

Initial campaign status. Defaults to active if omitted.

Available options:
active,
paused
countries
integer[]

GeoNames country IDs to restrict the campaign to. Omit or pass an empty array for no restriction.

Response

Campaign created.

status
enum<string>
Available options:
success
code
enum<integer>
Available options:
201
name
enum<string>
Available options:
Created
message
string
Example:

"Campaign created"

info
object