Sign in
crm-email

Cancel a scheduled CRM email campaign

Admin-only endpoint. Cancels a still-scheduled campaign; rejects ones already running/sent.

post/api/campaigns/{campaign_id}/cancel

Path parameters

campaign_idstring uuid required

Campaign UUID

Campaign UUID

Response

Successful Response

idstring required

Campaign UUID.

statusstring required

scheduled | running | sent | failed | cancelled.

scheduled_atstring date-time nullable

When the campaign is/was scheduled to send.

subjectstring required

Email subject.

notesstring nullable

Internal note on why the campaign was sent; CRM-only.

audience_typestring required

'filters' or 'csv'.

audience_sizeinteger nullable

Recipient count for a csv audience; null for a filter audience.

resolved_countinteger nullable

Recipients resolved at send time (once sent).

sent_countinteger nullable

Messages enqueued (once sent).

send_offsetinteger nullable

Recipients dispatched so far across all completed waves (throttled sends).

last_wave_atstring date-time nullable

When the most recent send wave (batch) ran; null before the first wave.

next_wave_atstring date-time nullable

When the next throttled wave (batch) is due to run; null when idle/finished.

errorstring nullable

Failure reason, if the send failed.

created_atstring date-time required

When the campaign was created.

Changes

No recorded changes to this endpoint across all 1 revision of this API.