Pause campaign
POST/api/v1/campaigns/{id}/pause
Stop a running campaign from sending anything further.
campaigns:writePause and resume campaigns.
Notes
Optional body:
{ "reason": "..." }.Idempotent on an already-paused campaign. Pausing one that is not running returns
409 invalid_state rather than silently doing nothing, because a caller who asked to stop sending should know nothing was sending.Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
id |
path | string | Campaign id. Required. |
Example
curl "https://resources.ashwanth.dev/api/v1/campaigns/YOUR_ID/pause" \
-H "Authorization: Bearer $LEADMAGNET_API_KEY"
Try it
API key
Held in this page only, never saved or sent anywhere but this API. If you are signed in, you can leave it blank.
Parameters
id *Request
POST /api/v1/campaigns/{id}/pause