Skip to main content
PUT
Update an appointment

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Path Parameters

id
integer
required

The appointment identifier

Body

application/json
customer_id
integer

The customer ID.

user_id
integer | null

The user ID.

parent_appointment_id
string

The parent appointment ID.

relation_type
enum<string> | null

Filter by appointment relation type (parent or child).

Available options:
parent,
child
description
string | null

The description.

Maximum string length: 1000
scheduled_at
string<date-time> | null

The scheduled at.

status
enum<string> | null

The status.

Available options:
pending,
approved,
cancelled,
rejected,
completed,
no_show
cancellation_reason
string | null

The cancellation reason.

Maximum string length: 1000
room_id
integer | null

The room ID.

treatments
integer[]

The treatments.

A treatments value.

treatment_session_plans
object[] | null

The treatment session plans.

Response

success
string
required
data
AppointmentResource · object
required