Create a Booking Link

Request

Create a booking link that can be shared with a patient. The link allows the patient to self-book into an available appointment slot.

Booking links are tied to a specific patient and appointment type. The generated URL can be sent via SMS or email using the Send Message endpoint.

Security

apiKeyAuth and practiceGroupId

Bodyapplication/jsonrequired

slot_idstring

appointment_type_idstring or Array of strings

One of:

string

location_idstring or Array of strings

One of:

string

patient_idstring^\d+$

practitioner_idstring or Array of strings

One of:

string

from_datestring, (date-time)

Display only the slots available after this date

Example:"1989-04-11"

to_datestring, (date-time)

Display only the slots available before this date

Example:"1989-04-11"

expiry_datestring, (date-time)

ISO 8601 date format

Example:"1989-04-11"

maximum_use_countnumber, >= 1

link_namestring

curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking_links \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "slot_id": "string",
    "appointment_type_id": "string",
    "location_id": "string",
    "patient_id": "string",
    "practitioner_id": "string",
    "from_date": "1989-04-11",
    "to_date": "1989-04-11",
    "expiry_date": "1989-04-11",
    "maximum_use_count": 1,
    "link_name": "string"
  }'

Responses

Ok

Bodyapplication/json

booking_linkstringrequired

short_link_idstringrequired

Response

{
  "booking_link": "string",
  "short_link_id": "string"
}