Pause a campaign

POST/campaigns/{campaignId}/pause

Pauses a running campaign: nobody in it gets their next step until it resumes. Repeating the call is safe.

Try itSend a real request with your API key

Path

campaignIdstringRequired
The campaign.

Headers

Idempotency-Keystring
Any unique value up to 255 characters, like a UUID. The request runs once; repeats within 24 hours get the first answer, with Idempotent-Replayed: true. Up to 255 characters.

Answer

200 OK The campaign.

dataanyRequired

Errors

401 Unauthorizedunauthorized
404 Not foundnot_found not_in_campaign
409 Conflictconflict idempotency_in_progress workspace_busy campaign_finished campaign_without_list tag_limit lead_has_history campaign_not_launched campaign_cannot_resume ambiguous_email
422 Can’t processidempotency_key_reused
429 Too many requestsrate_limited
500 Server errorserver_error

Every error has the same shape. See Errors.

POST /campaigns/{campaignId}/pause

curl -X POST "https://app.salesteam.dev/api/v1/campaigns/CAMPAIGN_ID/pause" \
  -H "Authorization: Bearer $SALESTEAM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch("https://app.salesteam.dev/api/v1/campaigns/CAMPAIGN_ID/pause", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SALESTEAM_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
console.log(response.status, await response.json());

import os, uuid
import requests

response = requests.post(
    "https://app.salesteam.dev/api/v1/campaigns/CAMPAIGN_ID/pause",
    headers={"Authorization": f"Bearer {os.environ['SALESTEAM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
)
print(response.status_code, response.json())

200 answer

{
  "data": null
}