Skip to main content
PATCH
cURL
Updates the status of a campaign. Use this to pause, resume, complete, or cancel a campaign.

Status Transitions

  • ACTIVE —> PAUSED, COMPLETED, CANCELLED
  • PAUSED —> ACTIVE, COMPLETED, CANCELLED
  • COMPLETED —> (terminal - no further transitions)
  • CANCELLED —> (terminal - no further transitions)

Authorizations

public-api-key
string
header
required
private-secret-key
string
header
required

Path Parameters

campaign_id
string
required

The campaign identifier (UUID).

Body

application/json
status
enum<string>
required

New status for the campaign.

Available options:
ACTIVE,
PAUSED,
COMPLETED,
CANCELLED

Response

200 - application/json
data
object