Set contacts' in-sequence status
contacts:operate scope (or a broader one that includes it).
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.
Authorizations
Authenticate every request with a Bearer token. Pass your Reply API key in the
Authorization header:
Get your API key from the Reply dashboard: Settings → API Key.
Body
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:
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.