Update an Appointment

put

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

Updates an existing appointment. This can be used to change the status (e.g., to confirmed or cancelled), reassign the provider, or modify other details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier for 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.

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.

notes

string

Any updated notes from the provider related to the appointment.

Headers

organization

string

required

Your unique Organization ID.

Response

200The appointment was updated successfully.