Update an Appointment

put

https://patient-api.portals.care/appointments/{id}

Update details for a specific appointment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Update a specific patient appointment. Authenticate by providing the patient's JWT in the authorization header

Provide the appointment id in the path and in the request body, provide the updated appointment information.

Path Params

string

required

The unique identifier of the appointment to update.

Body Params

A Data Transfer Object (DTO) for updating an existing patient appointment. This is used to change the appointment's status, notes, or reschedule it.

service

string

The unique identifier of the service being updated.

serviceId

string

The unique identifier of the service being updated. This is a duplicate of the service field.

serviceType

string

The type of service being updated.

schedule

string

The unique identifier of the new provider's schedule that the appointment is being booked within.

status

object

The updated status of the appointment.

cancellationReason

string

The reason for canceling the appointment. This field is required if the status is set to 'cancelled'.

reservation

date-time

The updated scheduled date and time of the appointment in ISO 8601 format.

relatedToLead

object

An object containing a subset of the patient's information.

urgency

number

An updated numerical value indicating the urgency of the appointment.

notes

string

Any updated notes from the patient or provider related to the appointment.

Headers

authorization

string

required

A Valid JWT Authentication token.

organization

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Language

Loading…

Response

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

application/json

200