---
title: "Text the patient a link to show their appointments"
method: POST
path: "/api/public/dental-network/tools/start_xona_appointment_access"
---

# Text the patient a link to show their appointments

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

## Request

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

Text a patient one link to see, move or cancel the appointments they already have at a practice connected to Xona, for a conversation with no booking action_id that still works. If the mobile number, name and date of birth match a patient there, Xona texts them the link; after they tap it and press Show my appointments, list_xona_appointments reads their appointments. The answer is the same whether or not the details match.

## Request body

- object
  - `date_of_birth` string, date, required
  - `first_name` string, required
  - `last_name` string, required
  - `patient_phone` string, required: The patient's own Canadian or US mobile number, as the practice has it on file
  - `practice_slug` string, required

## Response `200`

Text the patient a link to show their appointments

- object
  - `action_id` string, required
  - `link_expires_at` string, date-time, required
  - `next_step` string, required
  - `practice` object, required
    - `name` string, required
    - `slug` string, required
  - `status` 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)