Skip to main content
POST
Set contacts' status in this sequence

Authorizations

Authorization
string
header
required

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.

Path Parameters

id
integer
required

Sequence ID

Body

application/json
contactIds
integer[]
required

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

Required array length: 1 - 100 elements
statusInSequence
enum<string>
required

Target in-sequence status to set.

Available options:
active,
paused,
finished,
outOfOffice

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:

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

{key}
NotProcessedItemResult · object

Per-item error for non-atomic bulk operations. Only failed items are returned in the response dictionary. Items not present in the dictionary succeeded.