v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Automations

Pause, resume, or cancel a manual-audience run

Controls an in-flight manual-audience run. pause holds delivery at the next step boundary (resumable); resume continues a paused run; cancel stops it for good — emails already sent are NOT recalled and a canceled run can't be resumed. 409 if the run is not in a state that allows the action (e.g. resuming a run that isn't paused); 404 for an unknown audienceRunId.

post/v1/automations/audience-runs/{audienceRunId}/control

Path parameters

audienceRunIdstring required

The audience run id (from POST /v1/automations/{automationId}/run or GET /v1/automations/audience-runs).

Example:arun_01HZ

The audience run id (from POST /v1/automations/{automationId}/run or GET /v1/automations/audience-runs).

Request body

action'pause' | 'resume' | 'cancel' required

Response

The run's new status after the control action.

audienceRunIdstring required
status'paused' | 'running' | 'canceled' required