Aura-from-Unity

Activate or Pause a Campaign

Use this endpoint to toggle the status of an existing campaign between Active and Inactive.

L

Written by Lior Avidar

Updated over a month ago

Endpoint:
PUT /external/v1/campaigns/:campaignId/status

Required Header:
Authorization: Bearer YOUR_API_TOKEN

Path Parameter:

campaignId (Number) – The ID of the campaign to update

Request Body Example:

{
  "data": {
    "status": "Active"
  }
}

Accepted values:

"Active" – Resume campaign delivery
"Inactive" – Pause campaign delivery

Example Response:

{
  "campaignId": 123456,
  "updated": true
}

Validation Rules:

Campaign must be in a valid state for activation (e.g., not capped or expired)
Only Active and Inactive are valid values

Possible Errors:

400 – campaign capped: Cannot activate a campaign with a reached cap
400 – invalid status: Must be either Active or Inactive
403 – unauthorized: Missing or insufficient permissions
404 – not found: Campaign ID does not exist

Related Articles

Update Campaign Settings

Update Campaign Capping

Update Segment Capping