/sequences/:id/cancel

Stops recipients of one sequence. With emails, it cancels the active recipients with those addresses: all of them if you have read-write access to the sequence, otherwise only the ones you added. Without emails, it cancels every active recipient you added to this sequence. Cancelled recipients get no further emails and are marked completed. You need access to the sequence; without it the response is still 200 with an empty list. An empty emails array cancels nobody. emails must be an array of strings; any other value returns 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Have you seen Incoming Webhooks?

See Incoming Webhooks that allow you to easily cancel a sequence recipient without writing code

Response structure

PropertyTypeDescription
recipientsString[]The list of recipient email addresses that were exited from the sequence.
Path Params
string
required

The sequence id to cancel

Body Params
emails
array of strings

The email addresses of the recipients to cancel. Leave out to cancel every active recipient you added. An empty array cancels nobody.

emails
Responses

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