Book appointment

POST

/v1/actions/hospitality.action.book_appointment/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.book_appointment/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "booked_at": "2026-04-15T12:00:00Z", "duration_minutes": 1, "external_record_reference_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "external_ref": "example", "guest_kind": "hotel_guest", "notes": "example", "outlet_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "person_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "price": { "amount": "example", "currency": "example" }, "provider_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "start_at": "2026-04-15T12:00:00Z" }, "return_modified": false }'

• Production API

Book a timed service: one guest × one service in a time window. Snapshots price, duration, and the pre/cleanup buffer pair from the spa_service at booking (catalogue edits never rewrite booking history); duration_minutes and price parameters override the snapshot for skill-level or yield-priced bookings (Book4Time price scaling). Conflict checks: the room admits at most capacity overlapping appointments over the buffered window [start - pre_time, end + cleanup_time]; a provider is single-booked over the same window. The capability maps (treatment_room_supports_service, staff_performs_spa_service) are enforced only when the resource declares at least one row. A service bound to a wellness_modality with requires_medical_licensing = true requires external_record_reference_id (the 0005 clinical seam). Business time: booked_at is when the booking was taken (defaults to now); replayed histories pass it explicitly so pace/lead-time reads derive correctly. A present external_ref routes the create through the appointment_external_ref business key, making a crashed-pass retry a replay instead of a duplicate booking. A couples service is two appointments sharing a capacity-2 room. Emits spa.appointment_booked.

Effects: create hospitality.appointment; link hospitality.link.appointment_for_service; link hospitality.link.appointment_at_outlet; link hospitality.link.appointment_in_treatment_room; link hospitality.link.appointment_with_provider; link hospitality.link.appointment_for_person; link hospitality.link.appointment_references_external_record.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.book_appointment:apply

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

booked_at

When the booking was taken — business time, not record time (defaults to now)

string format: date-time

duration_minutes

Duration override in minutes (skill-level / guest-specific duration)

integer

external_record_reference_id

Clinical-record reference (mandatory when the bound modality requires_medical_licensing)

string format: uuid

external_ref

Source-system key for replayed / connector-landed bookings

string

guest_kind

Who the client is to the property (in-house capture dimension)

string

Allowed values: hotel_guest member external

notes

Front-desk / therapist notes (may carry intake detail)

string

outlet_id

required

Outlet the appointment trades under

string format: uuid

person_id

Guest the appointment is for (optional — desk walk-ins may book anonymously)

string format: uuid

price

Price override (skill-level / yield pricing; defaults to the service's list price)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

provider_id

Provider / therapist (optional — may be assigned later via reschedule)

string format: uuid

room_id

Treatment room (optional — may be assigned later via reschedule)

string format: uuid

service_id

required

Service being booked

string format: uuid

start_at

required

Treatment start

string format: date-time

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.appointment_for_service hospitality.link.appointment_at_outlet hospitality.link.appointment_in_treatment_room hospitality.link.appointment_with_provider hospitality.link.appointment_for_person hospitality.link.appointment_references_external_record

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: created

object_type

required

Allowed values: hospitality.appointment

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.appointment_for_service"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.appointment"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.