Book reschedule or cancel an appointment atomically

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

POST

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

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

contactId
string
required
format: uuid

Header parameters

X-Workspace-Id
string
required

Request body JSON required

requestId
string
required
format: uuid
operation
book
or
reschedule
or
cancel
required
offerId
optional
string
format: uuid
appointmentId
optional
string
format: uuid
revision
optional
integer
minimum: 1
expectedUpdatedAt
optional
string
Last viewed appointment timestamp; required for internal appointments without a visit revision

format: date-time
reason
optional
string
Required for cancellation

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

Book reschedule or cancel an appointment atomically

curl --request POST \
  --url 'https://api.channelautomation.com/api/call-center/contacts/<contactId>/appointment-changes' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: string' \
  --data '
{
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "operation": "book",
  "offerId": "42da58f8-9040-4cf5-98ce-bce9965cca0d",
  "appointmentId": "24c6adb3-18be-4108-aa61-3d58879e05a2",
  "revision": 1,
  "expectedUpdatedAt": "2019-08-24T14:15:22Z",
  "reason": "string"
}
'

const url = 'https://api.channelautomation.com/api/call-center/contacts/<contactId>/appointment-changes';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-Workspace-Id': 'string',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({
    requestId: 'd385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6',
    operation: 'book',
    offerId: '42da58f8-9040-4cf5-98ce-bce9965cca0d',
    appointmentId: '24c6adb3-18be-4108-aa61-3d58879e05a2',
    revision: 1,
    expectedUpdatedAt: '2019-08-24T14:15:22Z',
    reason: '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>/appointment-changes"

payload = {
    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
    "operation": "book",
    "offerId": "42da58f8-9040-4cf5-98ce-bce9965cca0d",
    "appointmentId": "24c6adb3-18be-4108-aa61-3d58879e05a2",
    "revision": 1,
    "expectedUpdatedAt": "2019-08-24T14:15:22Z",
    "reason": "string"
}
headers = {
    "Content-Type": "application/json",
    "X-Workspace-Id": "string",
    "Authorization": "Bearer <token>"
}

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

print(response.text)