Record demand forecast

POST

/v1/actions/hospitality.action.record_demand_forecast/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_demand_forecast/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "forecast_as_of": "2026-04-15T12:00:00Z", "notes": "example", "points": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "segment": "total", "source": "desk" }, "return_modified": false }'

• Production API

Record a forecast for a property: one point per arrival night, all as of one instant, for one segment, from one source. points is a JSON array of {arrival_date, forecast_rooms, forecast_adr, demand_rooms?, on_the_books?, external_ref?} — ADR in the property’s default currency, demand_rooms the unconstrained estimate when the forecaster has one. Every point becomes an immutable demand_forecast and emits the forecast.point.recorded feed event the rate-recommendation path emits, so the realization sweep grades it against the night’s actual. A point carrying an external_ref already recorded is skipped, object and feed event both: a replayed re-forecast writes nothing.

Effects: create hospitality.demand_forecast; link hospitality.link.demand_forecast_for_property.

Authorizations

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

forecast_as_of

When the forecast was made (defaults to now; must not be in the future)

string format: date-time

notes

How the forecast was made

string

points

required

JSON array of points: {arrival_date, forecast_rooms, forecast_adr, demand_rooms?, on_the_books?, external_ref?}

property_id

required

The house the forecast is for

string format: uuid

segment

required

Market segment forecast, or `total` for the house as a whole

string

Allowed values: total transient group contract

source

required

Who produced the forecast

string

Allowed values: desk rms import

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.demand_forecast_for_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.demand_forecast

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

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.