post

POST /v2/campaigns — Create a campaign

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a new promotional campaign with placement assets and optional coupon configuration.

Request body

FieldTypeRequiredDescription
namestringYesCampaign display name
descriptionstringNoCampaign description
prioritynumberNoRendering priority (higher = shown first)
startDatedateYesCampaign start date (ISO 8601)
endDatedateYesCampaign end date (ISO 8601)
entryPointTypestringYesType of entry point (e.g. product, category)
entryPointIdstringYesID of the entry point resource
couponConfigobjectNoCoupon rules to apply when the campaign is triggered
placementAssetsarrayNoPlacement asset definitions (image, copy, links per placement slot)
statusstringNoInitial status
isLivebooleanNoWhether the campaign is immediately live (default: false)

Errors

StatusCodeDescription
409duplicate_campaign_nameA campaign with this name already exists for the affiliate

Required role

Affiliate token required

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!