campaign_action · Escouade Mail documentation

Run a campaign.

Actions: start (confirm=true after review, optional starts_at), pause, resume, stop, archive, restore, duplicate. A pause holds the queued sends; stop cancels those that have not left yet. Imported history can be archived or duplicated, never started again.

Access

Key: an Escouade Mail key with send.
Space: a verified space.
Changes nothing: no, it acts.
Safe to replay: use an idempotency_key where the tool offers one.

Parameters

Parameter	Type	Required	Description
`campaign_id`	string	yes	Campaign.
`action`	one of `start`, `pause`, `resume`, `stop`, `archive`, `restore`, `duplicate`	yes	One of start, pause, resume, stop, archive, restore, duplicate.
`starts_at`	string	no	Earliest first departure; the window applies afterwards.
`confirm`	boolean	no	Start reviewed and confirmed.
`revision`	string	no	Fingerprint returned by preview_campaign, required for start.

Call it

Terminal

curl -s https://api.subagent.fr/v1/campaign_action \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sak_…' \
  -d '{"campaign_id": "…", "action": "…"}'

The full page in French, with the response fields and every refusal the tool can return: /mail/docs/reference/campaign_action.