Skip to main content
POST
/
campaigns
Create campaign
curl --request POST \
  --url https://api.agentic.scope3.com/api/v2/buyer/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "advertiserId": 12345,
  "name": "Q1 2025 Campaign",
  "flightDates": {
    "startDate": "2025-01-15T00:00:00Z",
    "endDate": "2025-03-31T23:59:59Z"
  },
  "budget": {
    "total": 1,
    "currency": "USD",
    "dailyCap": 1,
    "pacing": "EVEN"
  }
}
'
{
  "campaign": {
    "campaignId": "cmp_987654321",
    "advertiserId": "12345",
    "name": "Summer 2025 Campaign",
    "status": "DRAFT",
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-20T14:45:00Z",
    "brief": "<string>",
    "flightDates": {
      "startDate": "2025-01-15T00:00:00Z",
      "endDate": "2025-03-31T23:59:59Z"
    },
    "budget": {
      "total": 1,
      "currency": "USD",
      "dailyCap": 1,
      "pacing": "EVEN"
    },
    "constraints": {
      "channels": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ]
    },
    "performanceConfig": {
      "optimizationGoal": {
        "eventSourceId": "es_abc123",
        "eventType": "page_view",
        "targetRoas": 4,
        "targetCpa": 25,
        "attributionWindow": {
          "clickThrough": "7d",
          "viewThrough": "1d"
        }
      }
    },
    "productCount": 15
  }
}

Authorizations

Authorization
string
header
required

API key or access token

Body

application/json

Request body for creating a campaign

advertiserId
integer
required

Advertiser ID that will own this campaign

Required range: x <= 9007199254740991
Example:

12345

name
string
required

Name of the campaign

Required string length: 1 - 255
Example:

"Q1 2025 Campaign"

flightDates
object
required

Campaign flight dates

budget
object
required

Campaign budget configuration

brief
string

Natural language brief for product search context

Maximum string length: 5000
Example:

"Looking for premium video inventory targeting tech enthusiasts"

constraints
object

Campaign targeting constraints

bundleId
string

Attach an existing bundle to the campaign

Minimum string length: 1
Example:

"abc123-def456-ghi789"

productIds
string[]

Product IDs to pre-select from the bundle (requires bundleId)

Example:
["prod_123", "prod_456"]
performanceConfig
object

Performance optimization configuration

Response

Create campaign

Response containing a single campaign

campaign
object
required

Campaign resource representation