Skip to content
aerandil.com
GitHub

Set guest replies

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

Switch the property’s guest replies on or off — the six event_named automations that answer a guest who is waiting: their room is ready (room_queue.room_ready), the housekeeping they asked for is done (housekeeping.task.completed), the fault they reported is fixed (work_order.completed). Three fire record_guest_message into the guest’s own conversation — the asking message’s, or, for a request the desk keyed for their stay, the one they have open at the house — on the channel they last wrote on, and only when there is one. Three write first, through message_guest, to a guest who has no conversation open at the house — whose request the desk keyed, or who is queued for a room: by text, else email, to the contact their profile holds; an event answers through one of the two kinds, never both. The first call installs them at the property (in draft when switched off), and a later call installs any the house lacks; enabled activates them, false pauses them. Off by default: a house that never calls this has none, and installed definitions are ordinary automations the tenant can read, tune while paused (update_automation) and archive. Delivery is the messaging adapter’s: the kernel records the outbound message, and its creation is what a channel adapter subscribes to. Emits guest_replies.set.recorded.

Effects: create hospitality.automation; modify hospitality.automation.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
enabled
required
Whether the house answers waiting guests automatically
boolean
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

Section titled “Responses”

200

Section titled “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 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: created modified
object_type
required
Allowed values: hospitality.automation
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": "created",
      "object_type": "hospitality.automation"
    }
  ]
}

409

Section titled “409”

Conflict — concurrent modification or unique constraint violation.

422

Section titled “422”

Validation error — parameter validation or business-rule violation.