Skip to main content
PATCH
Update a campaign’s state. Currently supports pausing and resuming campaigns.

Request

string
required
Your API key
string
required
The campaign ID
string
required
The action to perform. Options: pause, resume

Response

boolean
Whether the action was successful
string
Campaign identifier
string
The action that was performed
string
The new status of the campaign
string
Confirmation message
When a campaign is paused or resumed, the corresponding webhook event (campaign.paused or campaign.resumed) will be sent to your registered webhook endpoints.

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

id
string
required

Campaign ID

Body

application/json
action
enum<string>
required

Action to perform on the campaign

Available options:
pause,
resume

Response

Campaign updated successfully

success
boolean
required
campaignId
string
required
action
string
required
newStatus
string
required
message
string
required