Skip to main content
PUT
Update an appointment

Yetkilendirmeler

Authorization
string
header
gerekli

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

Başlıklar

X-Tenant
number
gerekli

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

Yol Parametreleri

id
integer
gerekli

The appointment identifier

Gövde

application/json
customer_id
integer

The customer ID.

user_id
integer | null

The user ID.

is_control_appointment
boolean | null

Whether this appointment overrides its treatments' normal session plan with a single control-type session per treatment. Cannot be changed after the appointment is created.

assistant_id
integer | null

The assistant ID (deprecated, use assistant_ids).

assistant_ids
integer[] | null

The assistant IDs.

An assistant IDs value.

parent_appointment_id
string

The parent appointment ID.

relation_type
enum<string> | null

Filter by appointment relation type (parent or child).

Mevcut seçenekler:
parent,
child,
null
description
string | null

The description.

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

The scheduled at.

send_message
boolean | null

Whether to send the appointment-updated notification to the customer when a date/time, doctor or treatment change is saved. Defaults to the tenant setting when omitted.

channel_id
integer | null

The channel the appointment notifications are sent on. Must be connected (GET /appointments/{id} → customer.notification_channels[].status = open); a closed or connecting channel is rejected. Send null to fall back to automatic resolution.

channel_identifier
string | null

The customer's address on the chosen channel: phone number for WhatsApp, numeric chat ID for Telegram (usernames cannot be messaged), IGSID for Instagram. Required when the customer cannot be reached on channel_id yet; it is saved as a customer identity so the notification can be delivered.

Maximum string length: 255
duration_minutes
integer | null

The appointment duration in minutes.

Gerekli aralık: 5 <= x <= 1440
status
enum<string> | null

The status.

Mevcut seçenekler:
pending,
approved,
cancelled,
rejected,
completed,
no_show,
null
cancellation_reason
string | null

The cancellation reason.

Maximum string length: 1000
room_id
integer | null

The room ID.

tags
integer[] | null

Tag identifiers to attach to the appointment.

A tag ID.

treatments
integer[]

The treatments.

A treatments value.

treatment_session_plans
object[] | null

The treatment session plans.

Yanıt

success
string
gerekli
data
AppointmentResource · object
gerekli