Preview Update guest profile (dry-run)

POST

/v1/actions/hospitality.action.update_guest_profile/preview

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.update_guest_profile/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "address": { "city": "example", "country": "example", "line1": "example", "line2": "example", "postal_code": "example", "region": "example" }, "connecting_room_ok": true, "date_of_birth": "2026-04-15", "dietary": [ "example" ], "email": "example", "family_name": "example", "given_name": "example", "language": "example", "nationality": "example", "phone": "example", "pillow": "example", "quiet_room": true, "room_floor_preference": "low", "tax_identifier": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.person" } }'

• Production API

Scenario preview of apply_hospitality_action_update_guest_profile — runs the action exactly as apply would (validation, handler dispatch, modified-object projection, commit-time cross-link validation) then rolls the transaction back. Returns the modified_objects / modified_links / warnings the apply would have produced without persisting anything or firing any outward effect. Requires the same actions:hospitality.action.update_guest_profile:apply scope as apply. No Idempotency-Key.

Authorizations

• aerandil_oauth

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

address

Guest postal address

object

city

required

string

country

required

string

line1

required

string

line2

string

postal_code

string

region

string

connecting_room_ok

Connecting rooms acceptable

boolean

date_of_birth

Date of birth

string format: date

dietary

Dietary requirements (empty list clears)

Array<string>

email

Email (empty clears)

string

family_name

Family name

string

given_name

Given name

string

language

Preferred language (empty clears)

string

nationality

Nationality, ISO 3166-1 alpha-2 (empty clears)

string

phone

Phone (empty clears)

string

pillow

Pillow preference (empty clears)

string

quiet_room

Prefers a quiet room

boolean

room_floor_preference

Floor preference

string

Allowed values: low mid high any

tax_identifier

Personal tax identifier, where a jurisdiction prints one on a guest's invoice (empty clears)

string

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

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.person

Responses

200

Preview computed and rolled back. modified_objects and modified_links carry the effect set the apply would produce; preview is always true.

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 unlinked properties_updated end_dated

link_type

required

string

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: modified

object_type

required

Allowed values: hospitality.person

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"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.person"
    }
  ]
}

Headers

Cache-Control

string

Allowed value: no-store

Always no-store — uncommitted live data.

409

Conflict — concurrent modification or unique constraint violation the apply would hit.

422

Validation error — the apply would be rejected.