v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Contacts

Set contacts' in-sequence status

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

Sets the in-sequence status (active / paused / finished / outOfOffice) for the given contacts across every sequence they are currently enrolled in.

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

To restrict the change to a single sequence, use POST /v3/sequences/{id}/contacts/set-status-in-sequence instead.

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

post/v3/contacts/set-status-in-sequence

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 ContactError enum. Common per-item slugs:

Slug	Meaning
notFound	Contact does not exist
forbidden	Caller lacks permission for this contact
sequenceNotFound	Derived sequence not accessible
invalidInput	Value rejected for this contact

object required

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