Reschedule an appointment

post

https://api.talkdeskapp.com/healthcare/appointments/{appointment_id}/rescheduling

Reschedule an existing appointment using its unique appointment ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

hls-appointment:write

Path Params

appointment_id

string

required

length between 1 and 2147483647

The unique identifier of the original appointment to reschedule

Query Params

interaction_id

string

required

length between 1 and 2147483647

Required interaction Id

Body Params

The details for the appointment rescheduling

location_id

string

required

length ≤ 50

The unique identifier of the service location/department for the rescheduled appointment

provider_id

string

required

length ≤ 50

The unique identifier of the provider for the rescheduled appointment

service_type_id

string

required

length ≤ 50

The unique identifier of the specialization/area of expertise for the rescheduled appointment

date_time

date-time

required

The time at which the rescheduled appointment starts

duration

integer

required

1 to 1440

The duration of the appointment in minutes

time_zone_id

string

required

length ≤ 100

The time zone of the rescheduled appointment as an IANA time zone identifier (e.g., "America/Chicago")

comments

array of strings

required

List of comments associated with the appointment

comments*

is_review_only

boolean

Flag indicating if this is only for review purposes

reschedule_comments

string

length ≤ 1000

Comments specifically related to the rescheduling action

reschedule_reason

string

length ≤ 100

The reason code for rescheduling the appointment

sub_location

string

length ≤ 100

The sub-location (department) for the rescheduled appointment

Responses

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

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

415Unsupported Media Type