Skip to main content
POST
/
campaigns
/
{campaignId}
/
pause
Pause campaign
curl --request POST \
  --url https://api.agentic.scope3.com/api/v2/buyer/campaigns/{campaignId}/pause \
  --header 'Authorization: Bearer <token>'
{
  "campaignId": "cmp_987654321",
  "previousStatus": "DRAFT",
  "newStatus": "DRAFT",
  "success": true
}

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
id
string
required

Unique identifier for the campaign

Minimum string length: 1
Example:

"cmp_987654321"

Response

Pause campaign

Response from executing or pausing a campaign

​
campaignId
string
required

Campaign ID

Example:

"cmp_987654321"

​
previousStatus
enum<string>
required

Previous campaign status

Available options:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
ARCHIVED
​
newStatus
enum<string>
required

New campaign status

Available options:
DRAFT,
ACTIVE,
PAUSED,
COMPLETED,
ARCHIVED
​
success
boolean
required

Whether the status change was successful