/sequences/cancel

Stops recipients you added, in every sequence at once. Cancelled recipients get no further emails, their open sequence tasks are deleted, and they are marked completed. Paused recipients are included; recipients that already finished are left alone.

Send emails to cancel only those people. Without emails, or with an empty array, every active recipient you added, in every sequence, is cancelled. To stop one sequence instead, use POST /v1/sequences/{id}/cancel.

To cancel for your whole workspace, send orgId with emails. If you are a workspace admin, the listed emails are cancelled in every sequence, whoever in the workspace added them. Other members cancel only the recipients they added.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
emails
array of strings

The recipients to cancel. Must be an array.

emails
string

Stored as the recipients' completion reason. Defaults to manuallyCancelled.

string

The id of your workspace. Requires a non-empty emails array; without one the response is 403. If you are a workspace admin, the listed emails are cancelled in every sequence, for recipients added by any member of the workspace. If you are a member but not an admin, only the recipients you added are cancelled, as if you had not sent orgId. If you are not a member of the workspace, the response is 403.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!