Contacts

Withdraw Contacts 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.

post/contacts/withdraw-from-sequences

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/contacts/withdraw-from-sequences
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

sequence_idstring nullable

Sequence to withdraw from. Required unless remove_all is true.

contact_idsinteger[]

Contact primary keys to withdraw (max 5000).

target_statestring nullable

Terminal state to record: removed | completed | not_interested.

remove_allboolean

Withdraw from EVERY enrolled sequence. Ignores sequence_id.

sourcestring nullable

Origin label recorded on the resulting event.

Response

Successful Response

dataCrmRecordPayload 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".

Changes

No recorded changes to this operation across all 2 revisions of this API.