Skip to content

Record guest message

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

Record an inbound or outbound guest_message into Aerandil. Opens a guest_conversation lazily for the person at the property when none exists; appends the message; refreshes the conversation’s denormalised counters. PCI-DSS hard validator gates redacted_excerpt against Luhn-matching sequences. WhatsApp 24-hour service-window validator gates outbound free-form messages without a template_id. Rejected if the conversation is in a closed state or if GDPR erasure has been requested in-thread. A reply the kernel composes — outbound into a named conversation_id with no channel — goes back on the channel and thread of the guest’s most recent inbound message, to the conversation’s person, and is refused when the guest opted out of that channel or asked for erasure; an outbound message given no content_hash is hashed from its excerpt (the kernel wrote it, so the excerpt is the whole message).

Effects: create hospitality.guest_message; create hospitality.guest_conversation; modify hospitality.guest_conversation; link hospitality.link.guest_conversation_for_person; link hospitality.link.guest_conversation_at_property; link hospitality.link.guest_conversation_anchored_to_reservation; link hospitality.link.guest_message_in_conversation; link hospitality.link.guest_message_references_external_record.

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

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.guest_conversation_for_person hospitality.link.guest_conversation_at_property hospitality.link.guest_conversation_anchored_to_reservation hospitality.link.guest_message_in_conversation hospitality.link.guest_message_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 modified
object_type
required
Allowed values: hospitality.guest_message hospitality.guest_conversation
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.guest_conversation_for_person"
}
],
"modified_objects": [
{
"kind": "created",
"object_type": "hospitality.guest_message"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.