Recommend restriction
const url = 'https://api.aerandil.com/v1/actions/hospitality.action.recommend_restriction/apply';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"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"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.aerandil.com/v1/actions/hospitality.action.recommend_restriction/apply \ --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" } }'Emit a typed sell-restriction recommendation against the target property: a closure (closed), closed-to-arrival / departure, or a length-of-stay bound over start_date..=end_date, scoped to a room type, a rate plan, or the pair (at least one). At least one constraint must be set. The reading behind it — rooms remaining, the protection level, the demand and sell-up believed — and the forecast snapshot are frozen at issue as a restriction_recommendation in suggested state; a still- suggested prior against the same scope and range is superseded. Decision lifecycle flows through apply_restriction_recommendation / reject_restriction_recommendation / expire_restriction_recommendations. Joins an in-progress rate_recommendation_run when run_id is given and opens one otherwise; a run carries rate and restriction recommendations side by side. With lift it recommends the re-open instead: no constraint, and its apply lifts the rows standing in exactly this scope over the range.
Effects: create hospitality.restriction_recommendation; modify hospitality.restriction_recommendation; create hospitality.rate_recommendation_run; modify hospitality.rate_recommendation_run; link hospitality.link.restriction_recommendation_for_rate_plan; link hospitality.link.restriction_recommendation_for_room_type; link hospitality.link.restriction_recommendation_at_property; link hospitality.link.restriction_recommendation_part_of_run; link hospitality.link.run_for_property; link hospitality.link.restriction_recommendation_superseded_by.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
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).
object
object
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.
object
Responses
Section titled “Responses”Action applied. modified_objects and modified_links populated when return_modified: true was supplied.
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
Per-invocation correlation id; matches events.correlation_id for every event this action appended.
Links established or removed by this invocation. Empty when the caller did not request return_modified.
object
Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.
object
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.
object
Human-readable summary, suitable for logging or operator-UI surfacing.
Object type the warning was raised against.
Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.
Stable kebab-case rule identifier (e.g. comp-authority-over-limit).
Example
{ "modified_links": [ { "kind": "linked", "link_type": "hospitality.link.restriction_recommendation_for_rate_plan" } ], "modified_objects": [ { "kind": "created", "object_type": "hospitality.restriction_recommendation" } ]}Conflict — concurrent modification or unique constraint violation.
Validation error — parameter validation or business-rule violation.