Skip to main content
PATCH
/
v1
/
campaigns
/
{id}
curl -X PATCH https://api.sendpilot.ai/v1/campaigns/camp_xyz789 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "pause"
  }'

{
  "success": true,
  "campaignId": "camp_xyz789",
  "action": "pause",
  "newStatus": "paused",
  "message": "Campaign paused successfully"
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendpilot.ai/llms.txt

Use this file to discover all available pages before exploring further.

Update a campaign’s state. Currently supports pausing and resuming campaigns.

​
Request

​
X-API-Key
string
required
Your API key
​
id
string
required
The campaign ID
​
action
string
required
The action to perform. Options: pause, resume

​
Response

​
success
boolean
Whether the action was successful
​
campaignId
string
Campaign identifier
​
action
string
The action that was performed
​
newStatus
string
The new status of the campaign
​
message
string
Confirmation message
curl -X PATCH https://api.sendpilot.ai/v1/campaigns/camp_xyz789 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "pause"
  }'

{
  "success": true,
  "campaignId": "camp_xyz789",
  "action": "pause",
  "newStatus": "paused",
  "message": "Campaign paused successfully"
}
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