Skip to main content
POST
/
v3
/
contacts
/
set-bounced
Mark or unmark contacts as bounced
curl --request POST \
  --url https://api.reply.io/v3/contacts/set-bounced \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactIds": [
    123
  ],
  "isBounced": true,
  "resendEmails": true
}
'
{}

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.

Authorizations

​
Authorization
string
header
required

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.

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
​
isBounced
boolean
required

true marks the contacts as bounced; false clears the bounced flag.

​
resendEmails
boolean | null

Required (non-null) when isBounced=false; must be omitted when isBounced=true. When true, the previously bounced step is rescheduled for retry.

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 error codes mirror the controller's ContactError:

CodeMeaning
1NotFound — contact does not exist
3Forbidden — caller lacks permission for this contact
5SequenceNotFound — derived sequence not accessible
8InvalidInput — value rejected for this contact

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.