Skip to main content
POST
Remove many contacts from the sequence

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sequence_id
string<uuid>
required

Body

application/json

SEQ-26: one bulk removal.

scope='all' resolves the target set server-side from the filters below; scope='ids' uses the explicit list.

enrolment_ids
string<uuid>[]
Maximum array length: 1000
limit
integer | null

SEQ-49: with scope='all', act on only the FIRST n of the resolved set (in the roster's order) instead of every match.

Required range: 1 <= x <= 100000
scope
enum<string>
default:ids
Available options:
ids,
all
search
string | null
Maximum string length: 255
statuses
enum<string>[] | null

Where one contact stands in one sequence.

ACTIVE rows carry a due_at and are what the tick claims; CLAIMED is the in-flight guard between claim and outcome. PAUSED (SEQ-30) is a deliberate per-contact hold: unclaimable because the tick claims strictly on ACTIVE, yet still LIVE — it keeps its step and its one-live-sequence slot, and a compliance stop (reply, unsubscribe) reaches it. Everything else is settled: COMPLETED walked off the end; STOPPED was halted (reply, unsubscribe, bounce, manual, company pause); FAILED is terminal per the phase-1 ruling; SUPPRESSED was on the do-not-contact list; SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the reason visible in the grid.

Available options:
active,
claimed,
paused,
completed,
stopped,
failed,
suppressed,
skipped_duplicate
stop_reasons
enum<string>[] | null
Available options:
reply,
unsubscribe,
bounce,
manual,
company_reply,
row_left_audience,
step_removed,
removed

Response

Successful Response

removed
integer
required