Skip to main content
POST
/
api
/
v1
/
accounts
/
{account_id}
/
appointments
/
{id}
/
cancel
Cancel appointment
curl --request POST \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/appointments/{id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "cancellation_reason": "<string>"
}
'
{
  "id": 123,
  "contact_id": 123,
  "service_id": 123,
  "provider_id": 123,
  "appointment_at": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "cancellation_reason": "<string>",
  "conversation_id": 123,
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_access_token
string
header
required

All API requests must include the api_access_token header with a valid agent or administrator token.

Body

application/json
​
cancellation_reason
string

Reason for cancellation

Response

Appointment cancelled

​
id
integer
​
contact_id
integer
​
service_id
integer
​
provider_id
integer
​
appointment_at
string<date-time>
​
status
enum<string>
Available options:
pending,
confirmed,
completed,
cancelled,
rescheduled
​
notes
string
​
cancellation_reason
string
​
conversation_id
integer
​
created_at
string<date-time>