Message guest

POST

/v1/actions/hospitality.action.message_guest/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.message_guest/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "anchor_reservation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "body": "example", "channel": "sms", "person_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "purpose": "service" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

Write to a guest the house has not heard from, or write first in a conversation they already have: by SMS to the profile’s mobile number or by email to its address. With no channel, the kernel takes the first the guest can be reached on — a text when the profile holds a mobile number the guest has not stopped, else an email. The message lands in the guest’s conversation at the house (opened when they have none) and is queued for the kernel’s delivery adapter, which sends it after commit and records what happened. Refused when the profile holds no contact for the channel, when the guest asked for erasure or texted STOP in any conversation at the house, and — for a marketing message — when the profile holds no live marketing consent for the channel or the guest opted out of marketing there. A service message (the default) needs no marketing consent.

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.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.message_guest: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

anchor_reservation_id

The stay the message is about, when it opens a conversation

string format: uuid

body

required

What the message says

string

channel

sms or email; omitted, the first the guest can be reached on (a text, else an email)

string

Allowed values: sms email

person_id

required

The guest

string format: uuid

purpose

service (the default) or marketing

string

Allowed values: service marketing

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

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.guest_conversation_for_person hospitality.link.guest_conversation_at_property hospitality.link.guest_conversation_anchored_to_reservation hospitality.link.guest_message_in_conversation

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"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.