---
title: "Withdraw Contacts From Sequences"
method: POST
path: "/contacts/withdraw-from-sequences"
tags: ["Contacts"]
---

# Withdraw Contacts From Sequences

`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

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- WithdrawFromSequencesRequest: 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.
  - `sequence_id` string, nullable: Sequence to withdraw from. Required unless `remove_all` is true.
  - `contact_ids` integer[]: Contact primary keys to withdraw (max 5000).
  - `target_state` string, nullable: Terminal state to record: removed | completed | not_interested.
  - `remove_all` boolean: Withdraw from EVERY enrolled sequence. Ignores `sequence_id`.
  - `source` string, nullable: Origin label recorded on the resulting event.

## Response `200`

Successful Response

- ApiResponseCrmRecordPayload
  - `data` CrmRecordPayload, 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".
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)