Skip to main content
PATCH
/
contacts
/
status
/
clear
Clear contact status
curl --request PATCH \
  --url https://api.reply.io/v3/contacts/status/clear \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "contactIds": [
    123
  ],
  "statuses": [
    "OptedOut"
  ],
  "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 clear statuses from

​
statuses
enum<string>[]

Specific statuses to clear. If empty or not provided, clears all clearable statuses.

Available options:
OptedOut,
Called,
ToCall,
MeetingBooked,
Bounced,
Replied,
Finished
​
sequenceId
integer

Optional sequence ID for sequence-specific status clearing

Response

Contact statuses cleared successfully

​
affected
integer[]

IDs of contacts that were affected