Define checklist template

POST

/v1/actions/hospitality.action.define_checklist_template/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_checklist_template/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "area_kind": "lobby", "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "items": [ { "code": "example", "kind": "check", "label": "example" } ], "name": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "required": true, "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "task_type": "stayover" }, "return_modified": false }'

• Production API

Define the checklist for one housekeeping task type — and optionally one room type — as a brand standard (brand_id) or the house’s own (property_id; exactly one of the two). items are the list in order, each a stable code, the label the attendant reads and its kind: check (a tick; the only kind the score counts), photo (attached to the result), count or text. required makes complete_housekeeping_task refuse until a result for this template is recorded against the task. Replay-safe by its business key (scope, task type, room type): the same key again revises the active template’s name, items and required in place (an identical repeat writes nothing); after retire_checklist_template, the key mints a new template. A public-area task type’s list may name area_kind instead of a room type (2026-10-14) — every corridor’s, the pool’s — and the key is then (scope, task type, area kind). Emits checklist_template.defined.

Effects: create hospitality.checklist_template; modify hospitality.checklist_template; link hospitality.link.checklist_template_at_brand; link hospitality.link.checklist_template_at_property; link hospitality.link.checklist_template_for_room_type.

Authorizations

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

area_kind

The one kind of public area the list is for — a public-area task type only, never with room_type_id (absent: every area)

string

Allowed values: lobby corridor lift stairwell pool gym spa_area restaurant_floor toilets back_of_house exterior other

brand_id

Brand scope (exactly one of brand_id / property_id)

string format: uuid

items

required

Checklist items

Array<object>

object

code

required

string

kind

required

string

Allowed values: check photo count text

label

required

string

name

required

What the list is called on the handset

string

property_id

Property scope (exactly one of brand_id / property_id)

string format: uuid

required

Refuse task completion until a result is recorded (default false)

boolean

room_type_id

The one room type the list is for (absent: every room)

string format: uuid

task_type

required

The housekeeping task type the list is for

string

Allowed values: stayover departure vacant_pickup deep_clean turndown inspection public_area_clean public_area_inspection minibar laundry

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

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.checklist_template_at_brand hospitality.link.checklist_template_at_property hospitality.link.checklist_template_for_room_type

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.checklist_template

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.