sequences

Remove many contacts from the sequence

Removes the listed contacts, or with scope='all' every contact the given filters match, less any excluded_ids. The set is resolved on the server, never from a client-side id list, so the action covers every match across pages. Each removal keeps the durable single-remove semantics.

post/sequences/{sequence_id}/contacts/bulk-remove/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/sequences/{sequence_id}/contacts/bulk-remove/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

sequence_idstring uuid required

Request body

created_fromstring date-time nullable

Only remove contacts added on or after this instant. The grid's date range, which a scope='all' removal has to honour or it reaches past what the person was looking at.

created_tostring date-time nullable
enrolment_idsstring[]
excludeboolean

Read 'statuses' and 'stop_reasons' as 'everything but', matching the Contacts tab's one Include/Exclude toggle.

excluded_idsstring[]

With scope='all', contacts to leave out: the rows unticked after ticking the header checkbox.

group'in_progress' | 'needs_approval' | 'paused' | 'done' | 'blocked'

The Audience tab's tab a contact sits under; every contact is under one.

The tabs used to be counts that overlapped (a bounced contact was both "reachable" and "blocked", so the counts added up past the roster) and opened a list of names over the roster they repeated (Natsuki, 2026-10-02). They partition the roster now and filter it in place, so a tab's count is exactly the rows it shows, and each row's own status chip names the state that put it there.

Derived at read time from the status, the stop reason, the contact's current-step task and whether an address reaches them, never stored.

limitinteger nullable

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

scope'ids' | 'all'
searchstring nullable
sort'created_desc' | 'created_asc' | 'status' | 'status_desc' | 'next_due'

The orders the Audience tab can list a sequence's contacts in.

statusesEnrolmentStatus[] nullable
stop_reasonsStopReason[] nullable

Response

Successful Response

removedinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.