Skip to content

Update an appointment status

POST /appointments/{appointmentId}/status

Requests a connector-specific appointment status change. The server normalizes the supplied status to lowercase. Supported status values depend on the connector, and an unsupported change can return successful: false.

Operation ID: postAppointmentStatus
Authorization: BEARER or API key

Parameters

Name Location Type Required Description
appointmentId path string Yes Connector-assigned CRM appointment identifier.

Request body

New appointment status. Status support depends on connector capability.

Required: Yes

Content type: application/json

Schema: AppointmentStatusUpdateRequest

{
  "status": "tentative"
}

Responses

Status Description Body
200 Appointment status update result; connector support varies. AppointmentRecordResponse
400 Bad request, missing authentication, or connector error. ErrorResponse, string
401 The user session is expired or revoked. ErrorResponse, string