---
title: "Ask to move or cancel an appointment"
method: POST
path: "/api/public/dental-network/tools/change_xona_appointment"
---

# Ask to move or cancel an appointment

`POST /api/public/dental-network/tools/change_xona_appointment`

## Request

- Base URL: `https://book.xonark.com`
- URL: `https://book.xonark.com/api/public/dental-network/tools/change_xona_appointment`
- Auth: none required

Move or cancel one of the patient's appointments. Xona texts the patient a link to a page that shows the exact change. When they press its button (or type the code from the text on book.xonark.com/code) the practice's schedule changes, or, at a practice that confirms changes itself, the practice receives the request. Calling again with the same arguments returns the result, read live from the practice's schedule.

## Request body

- object
  - `action_id` string, required
  - `appointment_ref` string, required
  - `date` string, date: For a reschedule: the new time's date exactly as list_xona_reschedule_times returned it
  - `kind` 'cancel' | 'reschedule', required
  - `slot_fingerprint` string: For a reschedule: the new time's slot_fingerprint from list_xona_reschedule_times

## Response `200`

Ask to move or cancel an appointment

- object
  - `action_id` string, required
  - `appointment_ref` string, required
  - `appointment_start_local` string
  - `kind` string
  - `link_expires_at` string, date-time
  - `next_step` string, required
  - `practice` object, required
    - `name` string, required
    - `slug` string, required
  - `requested_start_local` string
  - `state` string, required

## Other responses

- `400`: Invalid request or action state
- `403`: Public write is disabled, or not a member of the claiming account
- `404`: Dental resource not found
- `410`: Dental action expired
- `413`: Request body too large
- `429`: Rate limit exceeded
- `502`: Clinic booking provider is unavailable
- `503`: Gateway temporarily unavailable
- `504`: Clinic booking provider timed out

---

[API](https://skmtc.dev/xonark/apis/xona-dental-gateway-public-api.md) · [All operations](https://skmtc.dev/xonark/apis/xona-dental-gateway-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xonark/apis/xona-dental-gateway-public-api/revisions/886252359184?raw)