Schedule appointments

post

https://api.talkdeskapp.com/healthcare/appointments

Schedule the appointment passed on body on the interaction using interactionId.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

hls-appointment:write

Query Params

interaction_id

string

required

length between 1 and 2147483647

Required interaction Id

notes

string

length between 1 and 2147483647

Notes of the scheduling appointment

notes_prefix

string

length between 1 and 2147483647

Prefix to add to appointment notes

Body Params

string

length between 1 and 2147483647

The id of the available slot from the external system.

service_type_id

string

length between 1 and 2147483647

The id of the specialization / area of expertise for the available slot.

start_date

date-time

length between 1 and 2147483647

The time at which the appointment starts for the available slot in UTC.

end_date

date-time

length between 1 and 2147483647

The time at which the appointment ends for the available slot in UTC.

provider_id

string

length between 1 and 2147483647

The id of the provider for the available slot.

location_id

string

length between 1 and 2147483647

The id of the service location / department for a provider for the available slot.

time_zone_id

string

length between 1 and 2147483647

The zone id of this available slot.

sub_location

string

length between 1 and 2147483647

The sub-location (department) for the available slot.

duration

integer

1 to 1440

Duration of the appointment in minutes.

order_id

string

length between 1 and 2147483647

Epic only. When provided, triggers the ScheduleMultipleAppointments Epic flow instead of the standard scheduling flow. Required when cancel_comments is set.

cancel_comments

string

length between 1 and 2147483647

Epic only. Comments explaining why an existing appointment is being cancelled as part of booking this new one. Requires order_id to be set; returns 400 if provided without it.

Responses

200

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

415Unsupported Media Type