campaign/archive_by_id
Tool: act
Archive a campaign (stops sending, hides from default list).
For Running campaigns the first call returns CONFIRMATION_REQUIRED; retry with confirm=true to proceed. Archived campaigns are excluded from campaign/get by default; restore with campaign/unarchive_by_id.
Arguments
| name | type | req | notes |
|---|---|---|---|
| id | integer | ✓ | Campaign ID — the object's campaignId |
| confirm | boolean | – | Set true after receiving CONFIRMATION_REQUIRED for a running campaign |
Response
200 — {campaignId: integer, status: string}. Deltas: none.
Errors: 400, 401, 404, 406, 409, 415, 422, 429, 500 — shared schema: schemas/errors.
Invoke
Call act with name: "campaign/archive_by_id".