Review defer dismiss or assign a recovery candidate

Requires a verified session, current workspace membership. Contact actions enforce visibility; visit configuration requires manager access.

PATCH

https://api.channelautomation.com/api/call-center/contacts/{contactId}/recovery

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

contactId
string
required
format: uuid

Header parameters

X-Workspace-Id
string
required

Request body JSON required

status
optional
ready
or
deferred
or
dismissed
assignedUserId
optional
string
or null
Manager only; omission preserves assignment

format: uuid
availableAt
optional
string
Required future time when deferring

format: date-time
expectedUpdatedAt
optional
string
Last observed updated_at; stale review returns 409

format: date-time
note
optional
string
maxLength: 1000

Returns

200

Successful operation

400

Invalid input

401

Invalid session

403

Access denied

404

Resource not found or resource not found

409

Resource changed concurrently

500

Unexpected error

503

Dependency unavailable

Review defer dismiss or assign a recovery candidate

curl --request PATCH \
  --url 'https://api.channelautomation.com/api/call-center/contacts/<contactId>/recovery' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: string' \
  --data '
{
  "status": "ready",
  "assignedUserId": "35a1b60a-b60e-4d90-8491-523f2d437a8e",
  "availableAt": "2019-08-24T14:15:22Z",
  "expectedUpdatedAt": "2019-08-24T14:15:22Z",
  "note": "string"
}
'

const url = 'https://api.channelautomation.com/api/call-center/contacts/<contactId>/recovery';
const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    'X-Workspace-Id': 'string',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({
    status: 'ready',
    assignedUserId: '35a1b60a-b60e-4d90-8491-523f2d437a8e',
    availableAt: '2019-08-24T14:15:22Z',
    expectedUpdatedAt: '2019-08-24T14:15:22Z',
    note: 'string'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/call-center/contacts/<contactId>/recovery"

payload = {
    "status": "ready",
    "assignedUserId": "35a1b60a-b60e-4d90-8491-523f2d437a8e",
    "availableAt": "2019-08-24T14:15:22Z",
    "expectedUpdatedAt": "2019-08-24T14:15:22Z",
    "note": "string"
}
headers = {
    "Content-Type": "application/json",
    "X-Workspace-Id": "string",
    "Authorization": "Bearer <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)