Beta. This endpoint is in beta. Behavior, parameters, and response shapes may change without notice.
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.
Documentation Index
Fetch the complete documentation index at: https://docs.reply.io/llms.txt
Use this file to discover all available pages before exploring further.
Authenticate every request with a Bearer token. Pass your Reply API key in the
Authorization header:
Authorization: Bearer <your-api-key>Get your API key from the Reply dashboard: Settings → API Key.
Sequence ID
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 |
Dictionary of per-item failures keyed by contact id. Empty object {} means all succeeded.
Per-item error for non-atomic bulk operations. Only failed items are returned in the response dictionary. Items not present in the dictionary succeeded.