Skip to main content
POST
Opt contacts out or clear their opt-out

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.

Body

application/json
contactIds
integer[]
required

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

Required array length: 1 - 100 elements
isOptedOut
boolean
required

true opts the contacts out; false clears the opted-out flag.

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. Contacts already in the requested state count as updated.

Per-item failures use the ContactError enum. Per-item slugs for this endpoint:

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.