Start a dental appointment request

Start an appointment request for Xona to send to the selected clinic (by email, or through the clinic's own website form). It takes the patient's details and preferred times. Xona emails the patient a link that shows the exact request; the request goes to the clinic only when the patient presses "Send this request" there, or enters the email's code on continue_url. The result carries consent_text and continue_url; confirm_dental_request reports the status. Use it where list_dental_practice_actions marks xona_email_appointment_request as completes_in_conversation.

post/api/public/dental-network/tools/start_dental_request

Request

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

Request body

notestring
patient_emailstring email required

The patient's own email; the link to send the request goes there

patient_namestring required

The patient's name as they typed it

patient_phonestring

The patient's phone as they typed it; required when the clinic's website form needs one

practice_slugstring required
preferred_windowstring required

When the patient is free, in their words

service_category'checkup_cleaning' | 'children' | 'cosmetic' | 'implants' | 'new_patient' | 'orthodontics' | 'other' | 'tooth_pain' required

Response

Start a dental appointment request

actionobject required
consent_textstring required
consent_versionstring required
next_stepstring required
verificationstring required

Changes

No recorded changes to this operation across all 1 revision of this API.