Preview Recommend restriction (dry-run)

POST

/v1/actions/hospitality.action.recommend_restriction/preview

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.recommend_restriction/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "cadence": "nightly", "closed": true, "closed_to_arrival": true, "closed_to_departure": true, "confidence": "low", "confidence_score": "example", "demand_forecast_rooms": "example", "end_date": "2026-04-15", "expires_at": "2026-04-15T12:00:00Z", "expires_on": "2026-04-15", "factors_considered": [ "pickup_pace" ], "forecast_snapshot": {}, "lift": true, "max_length_of_stay": 1, "min_length_of_stay": 1, "protection_level": 1, "rate_plan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rationale_text": "example", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rooms_remaining": 1, "run_id": "example", "sell_up_rate": "example", "start_date": "2026-04-15", "target_horizon_days": 1 }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

Scenario preview of apply_hospitality_action_recommend_restriction — runs the action exactly as apply would (validation, handler dispatch, modified-object projection, commit-time cross-link validation) then rolls the transaction back. Returns the modified_objects / modified_links / warnings the apply would have produced without persisting anything or firing any outward effect. Requires the same actions:hospitality.action.recommend_restriction:apply scope as apply. No Idempotency-Key.

Authorizations

• aerandil_oauth

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

cadence

Run cadence (used only when opening a fresh run)

string

Allowed values: nightly intraday hourly event_triggered manual

closed

Recommend a hard stop-sell (defaults to false)

boolean

closed_to_arrival

Recommend closed to arrival (defaults to false)

boolean

closed_to_departure

Recommend closed to departure (defaults to false)

boolean

confidence

required

Confidence ordinal

string

Allowed values: low medium high

confidence_score

Calibrated probability (optional)

string format: decimal

demand_forecast_rooms

Unconstrained higher-rate demand believed for the first night (rooms)

string format: decimal

end_date

required

Last night (inclusive)

string format: date

expires_at

Recommendation expiry (default: issued_at + 4h when absent)

string format: date-time

expires_on

The house business day the recommendation lapses after, in place of `expires_at`: the house's open business date decides expiry, not the wall clock, so a day's recommendations apply on that business day however late it closes

string format: date

factors_considered

required

Signals that drove the recommendation

Array<string>

Allowed values: pickup_pace booking_curve competitive_set event_calendar historical_pattern segment_mix channel_mix length_of_stay_distribution cancellation_rate no_show_rate package_attachment group_displacement weather other

forecast_snapshot

required

Forecast snapshot (struct as JSON; `forecast_kind` and `as_of` required)

object

key

additional properties

any

lift

Recommend lifting what stands in exactly this scope over the range — the re-open; exclusive with every constraint (defaults to false)

boolean

max_length_of_stay

Recommended maximum length of stay (nights)

integer

min_length_of_stay

Recommended minimum length of stay (nights)

integer

protection_level

Rooms the recommender wants kept for the higher rate

integer

rate_plan_id

Rate plan scope (at least one of room_type_id / rate_plan_id)

string format: uuid

rationale_text

required

Human-readable explanation

string

room_type_id

Room type scope (at least one of room_type_id / rate_plan_id)

string format: uuid

rooms_remaining

Rooms left to sell on the first night, at issue time

integer

run_id

Existing run to append to (handler opens one when absent)

string

sell_up_rate

Share of fenced-rate buyers believed to pay the higher rate once the fence closes (0..=1)

string format: decimal

start_date

required

First night

string format: date

target_horizon_days

Forecast horizon the run looked over (used only when opening a run)

integer

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

Preview computed and rolled back. modified_objects and modified_links carry the effect set the apply would produce; preview is always true.

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.restriction_recommendation_for_rate_plan hospitality.link.restriction_recommendation_for_room_type hospitality.link.restriction_recommendation_at_property hospitality.link.restriction_recommendation_part_of_run hospitality.link.run_for_property hospitality.link.restriction_recommendation_superseded_by

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.restriction_recommendation hospitality.rate_recommendation_run

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

Headers

Cache-Control

string

Allowed value: no-store

Always no-store — uncommitted live data.

409

Conflict — concurrent modification or unique constraint violation the apply would hit.

422

Validation error — the apply would be rejected.