Record recognition event

POST

/v1/actions/hospitality.action.record_recognition_event/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_recognition_event/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "comp_amount": { "amount": "example", "currency": "example" }, "comp_category": "example", "delivery_visibility": "visible_to_guest", "happened_at": "2026-04-15T12:00:00Z", "person_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "program_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "recogniser": "example", "recognition_action_text": "example", "recognition_kind": "name_acknowledged", "recognition_subject_text": "example", "stay_id": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

Log a recognition event against the target property. Always-on across all loyalty archetypes — the program_type does not gate recognition. The program reference is optional because recognition-only patterns without a formal program record events without a program ref. The pair with record_service_recovery lets the operator’s recognition-vs- recovery balance surface as a structural read about the property’s hospitality character.

Effects: create hospitality.recognition_event; link hospitality.link.recognition_event_for_person; link hospitality.link.recognition_event_for_program; link hospitality.link.recognition_event_at_property.

Authorizations

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

comp_amount

Comp amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

comp_category

Comp category (toolkit dictionary key)

string

delivery_visibility

required

Delivery visibility

string

Allowed values: visible_to_guest invisible_to_guest

happened_at

required

When the recognition happened

string format: date-time

person_id

required

Person being recognised

string format: uuid

program_id

Loyalty program (optional — recognition-only patterns may omit)

string format: uuid

recogniser

required

Recogniser principal identifier

string

recognition_action_text

What the operator did

string

recognition_kind

required

Recognition kind

string

Allowed values: name_acknowledged preference_anticipated relationship_remembered gesture_offered upgrade_provided amenity_provided personal_note_left birthday_anniversary_marked repeat_visit_acknowledged vip_treatment_initiated other

recognition_subject_text

What was recognised

string

stay_id

Stay context (when applicable)

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.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.recognition_event_for_person hospitality.link.recognition_event_for_program hospitality.link.recognition_event_at_property

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

object_type

required

Allowed values: hospitality.recognition_event

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.recognition_event_for_person"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.recognition_event"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.