get
https://example.com
POST /v2/campaigns — Create a campaign
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Creates a new promotional campaign with placement assets and optional coupon configuration.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Campaign display name |
description | string | No | Campaign description |
priority | number | No | Rendering priority (higher = shown first) |
startDate | date | Yes | Campaign start date (ISO 8601) |
endDate | date | Yes | Campaign end date (ISO 8601) |
entryPointType | string | Yes | Type of entry point (e.g. product, category) |
entryPointId | string | Yes | ID of the entry point resource |
couponConfig | object | No | Coupon rules to apply when the campaign is triggered |
placementAssets | array | No | Placement asset definitions (image, copy, links per placement slot) |
status | string | No | Initial status |
isLive | boolean | No | Whether the campaign is immediately live (default: false) |
Errors
| Status | Code | Description |
|---|---|---|
| 409 | duplicate_campaign_name | A campaign with this name already exists for the affiliate |
Required role
Affiliate token required
