v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Sequence Contacts

Set contacts' status in this sequence

<small>Requires the sequences:operate scope (or a broader one that includes it).</small>

Sets the in-sequence status (active / paused / finished / outOfOffice) for the given contacts, scoped to this sequence only.

To apply across every sequence a contact is in, use POST /v3/contacts/set-status-in-sequence instead.

Replied and Bounced are not values of this enum — use POST /v3/sequences/{id}/contacts/set-replied or POST /v3/sequences/{id}/contacts/set-bounced for those.

paused requires the contact to currently be active in this sequence — pausing from any other state is reported per-item as invalidStatusTransition. The other targets (active, finished, outOfOffice) accept any current state.

post/v3/sequences/{id}/contacts/set-status-in-sequence

Path parameters

idinteger required

Sequence ID

Request body

contactIdsinteger[] required

Contact IDs to update. At least one, at most 100. Each ID must be positive.

statusInSequence'active' | 'paused' | 'finished' | 'outOfOffice' required

In-sequence status values that can be set via POST /v3/contacts/set-status-in-sequence and POST /v3/sequences/{id}/contacts/set-status-in-sequence.

Replied and Bounced are not values of this enum — they are flipped via the dedicated set-replied / set-bounced endpoints. OptedOut, Called/ToCall, and MeetingBooked are contact-level (not in-sequence) and are flipped via PATCH /v3/contacts/{id} (isOptedOut, callStatus, meetingStatus).

Response

Non-atomic result. The response body is a dictionary keyed by contact id listing per-item failures. Empty object {} means all contacts were updated successfully.

Per-item failures use the SequenceContactError enum. Common per-item slugs:

Slug	Meaning
invalidInput	Generic validation failure for this contact
contactNotFound	Contact does not exist
notInSequence	Contact is not in this sequence
invalidStatusTransition	Disallowed transition from the current state
sequenceArchived	Sequence is archived
forbidden	Caller lacks permission for this contact

object required

Dictionary of per-item failures keyed by contact id. Empty object {} means all succeeded.