Skip to main content
POST
Create 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.

Body

application/json
customer_id
integer
required

The customer ID.

user_id
integer
required

The user ID.

scheduled_at
string<date-time>
required

The scheduled at.

status
enum<string>
required

The status.

Available options:
pending,
approved,
cancelled,
rejected,
completed,
no_show
treatments
integer[]
required

The treatments.

Minimum array length: 1

A treatments value.

assistant_id
integer | null

The assistant ID.

parent_appointment_id
integer | null

The parent appointment ID.

description
string | null

The description.

Maximum string length: 1000
cancellation_reason
string | null

The cancellation reason.

Maximum string length: 1000
room_id
integer | null

The room ID.

treatment_session_plans
object[] | null

The treatment session plans.

Response

success
string
required
data
AppointmentResource · object
required