Skip to main content
PATCH
/
contacts
/
status
Set contact status
curl --request PATCH \
  --url https://api.reply.io/v3/contacts/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "contactIds": [
    123
  ],
  "status": "Active",
  "sequenceId": 123
}
'
{
  "affected": [
    123
  ]
}

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header

Body

application/json
contactIds
integer[]
required

Array of contact IDs to update

status
enum<string>
required

Target status to set

Available options:
Active,
Paused,
OutOfOffice,
Finished,
OptedOut,
Replied,
Bounced,
Called,
ToCall,
MeetingBooked
sequenceId
integer

Optional sequence ID for sequence-specific statuses (Active, Paused, OutOfOffice, Finished, Replied, Bounced)

Response

Contact status updated successfully

affected
integer[]

IDs of contacts that were successfully updated