Create a Booking Link

Creates a booking link using the provided parameters.

SecurityapiKeyAuth and practiceGroupId

Request

Request Body schema: application/json
required

required	string or Array of strings
required	string or Array of strings
patient_id	string^\d+$
	string or Array of strings
from_date	string <date-time> Display only the slots available after this date
to_date	string <date-time> Display only the slots available before this date
expiry_date	string <date-time> ISO 8601 date format
maximum_use_count	number >= 1

Responses

200

400

Validation error

401

Unauthorised

422

Patient inexistent and/or Appointment Type inexistent

500

Unknown error

post/v1/booking_links

Request samples

Payload
curl
Node.js
Ruby

application/json

{"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
}

Response samples

application/json

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

Create a Booking Link

Request Body schema: application/jsonrequired

Request Body schema: application/json
required