campaign/pause_by_id
Tool: act
Pause a campaign (stop sending).
Pause is the only general-purpose "stop" action — it works on Running, Warning, Blocked, and even Draft campaigns. Resume by calling campaign/start_by_id.
A nonexistent campaign ID returns 422 "not found or access denied", NOT 404 (upstream quirk). Pausing a Draft campaign is allowed and changes status to Paused.
Arguments
| name | type | req | notes |
|---|---|---|---|
| id | integer | ✓ | Campaign ID — the object's campaignId |
Response
200 — {campaignId: integer, status: string}. Deltas: none. Returns lowercase status: "paused" while GETs return "Paused" — normalize before comparing (upstream inconsistency).
Errors: 400, 401, 404, 406, 409, 415, 422, 429, 500 — shared schema: schemas/errors. 422 if id not found (upstream quirk).
Invoke
Call act with name: "campaign/pause_by_id".