Skip to content

What-if Update guest profile (rollup delta)

POST
/v1/actions/hospitality.action.update_guest_profile/whatif
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.update_guest_profile/whatif \
--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" } }'

What-if projection of apply_hospitality_action_update_guest_profile — previews the action (execute-and-roll-back) and folds its would-be events into rollup deltas, returning the contribution an apply would make to the daily_rooms fact (ADR / RevPAR / TRevPAR / Occupancy inputs) without persisting anything. Requires the same actions:hospitality.action.update_guest_profile:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

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

Rollup deltas the action would contribute, computed and rolled back.

Media typeapplication/json
object
daily_rooms
required

Per (property, business_date) additive contribution to the rooms rollup.

Array<object>
object
business_date
required
string format: date
currency

ISO 4217, when the fold observed one.

string
property_id
required
string format: uuid
rooms_revenue_net_delta
required

Decimal, net rooms revenue delta.

string
rooms_sold_delta
required
integer format: int64
total_revenue_net_delta
required

Decimal, net total revenue delta.

string
Examplegenerated
{
"daily_rooms": [
{
"business_date": "2026-04-15",
"currency": "example",
"property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"rooms_revenue_net_delta": "example",
"rooms_sold_delta": 1,
"total_revenue_net_delta": "example"
}
]
}
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

Validation error — the apply would be rejected.