Skip to content

What-if Record guest message (rollup delta)

POST
/v1/actions/hospitality.action.record_guest_message/whatif
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.record_guest_message/whatif \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "anchor_reservation_id": "example", "author_kind": "guest", "author_principal": "example", "channel": "sms", "channel_thread_id": "example", "content_hash": "example", "conversation_id": "example", "detected_language": "example", "direction": "inbound", "external_record_id": "example", "language": "example", "person_id": "example", "received_at": "2026-04-15T12:00:00Z", "redacted_excerpt": "example", "redactions_applied": [ "pan" ], "template_id": "example", "word_count": 1 }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

What-if projection of apply_hospitality_action_record_guest_message — 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.record_guest_message: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
anchor_reservation_id
Optional reservation anchor (sets `conversation.anchor_reservation_ref`)
string
author_kind
Author kind (guest / staff_human / staff_agent / system)
string
Allowed values: guest staff_human staff_agent system
author_principal
`principal.stable_id()` of the author when not the guest
string
channel
Communication channel (a reply into a named conversation may omit it)
string
Allowed values: sms whatsapp email web_chat app_chat voice_ivr ota_inbox social_dm in_room_device other
channel_thread_id
External system thread identifier (taken from the guest's last message on a reply)
string
content_hash
SHA-256 of the original message bytes (outbound: derived from the excerpt when absent)
string
conversation_id
Existing conversation to append to (handler opens one when absent)
string
detected_language
BCP-47 language tag
string
direction
required
inbound or outbound
string
Allowed values: inbound outbound
external_record_id
Optional pointer to the external record reference
string
language
Initial language for new conversations (BCP-47)
string
person_id
The guest's person id (a reply into a named conversation takes the conversation's)
string
received_at
When the message arrived (inbound, required) or was sent (outbound; omitted = now, the kernel sending it)
string format: date-time
redacted_excerpt
required
PII-stripped excerpt (default cap 280 chars)
string
redactions_applied
required
Per-message redaction kinds
Array<string>
Allowed values: pan cvv government_id health_disclosure child_safeguarding other_pii
template_id
WhatsApp Business template id (required outside 24-hour window)
string
word_count
Optional word count
integer
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.property

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.