Skip to content

Withdraw Contacts From Sequences

POST
/contacts/withdraw-from-sequences

Take contacts OUT of a sequence. They stop receiving its steps.

remove_all=true withdraws them from EVERY sequence they are enrolled in and ignores sequence_id - the wider blast radius of the two, and never the default.

response is REQUIRED by the app handler rather than decoration: it sets a status on it for the partial-withdrawal case, so omitting it is an AttributeError on every call.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Take contacts OUT of a sequence. They stop receiving its steps.

remove_all=true withdraws them from EVERY sequence they are enrolled in and ignores sequence_id; that is the wider blast radius of the two and it is never the default.

object
contact_ids

Contact primary keys to withdraw (max 5000).

Array<integer>
<= 5000 items
remove_all

Withdraw from EVERY enrolled sequence. Ignores sequence_id.

boolean
sequence_id
Any of:
string
source
Any of:
string
<= 64 characters
target_state
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string