Skip to main content
POST
Create a new appointment request

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
schedule_uuid
string<uuid>
required

UUID of the schedule

Example:

"550e8400-e29b-41d4-a716-446655440000"

title
string
required

Appointment title

Example:

"Medical Consultation"

start_time
string<date-time>
required

Start time (must be in the future)

Example:

"2025-11-25 10:00:00"

contact_uuid
string<uuid>

UUID of existing contact (optional if contact details provided)

Example:

"660e8400-e29b-41d4-a716-446655440001"

contact_name
string

Contact name (required if contact_uuid not provided)

Example:

"John"

contact_surname
string

Contact surname (optional)

Example:

"Doe"

contact_email
string<email>

Contact email (required if contact_uuid not provided)

Example:

"john.doe@email.com"

contact_phone
string

Contact phone (optional)

Example:

"+1-555-0100"

description
string

Appointment description (optional)

Example:

"Annual checkup"

end_time
string<date-time>

End time (optional - if not provided, will use schedule's default duration from availability type)

Example:

"2025-11-25 10:30:00"

notes
string

Additional notes (optional)

Example:

"Patient prefers morning appointments"

Response

Appointment request created successfully

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"Appointment request created successfully"

data
object