What-if Set rate restriction (rollup delta)

POST

/v1/actions/hospitality.action.set_rate_restriction/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_rate_restriction/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "closed": true, "closed_to_arrival": true, "closed_to_departure": true, "end_date": "2026-04-15", "external_ref": "example", "max_length_of_stay": 1, "min_length_of_stay": 1, "posted_at": "2026-04-15T12:00:00Z", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rate_plan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "start_date": "2026-04-15" }, "return_modified": false }'

• Production API

What-if projection of apply_hospitality_action_set_rate_restriction — previews the action (execute-and-roll-back) and folds its would-be events into rollup deltas, returning the contribution an apply would make to the daily_rooms fact (ADR / RevPAR / TRevPAR / Occupancy inputs) without persisting anything. Requires the same actions:hospitality.action.set_rate_restriction:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

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

closed

Hard stop-sell (defaults to false)

boolean

closed_to_arrival

Closed to arrival (defaults to false)

boolean

closed_to_departure

Closed to departure (defaults to false)

boolean

end_date

required

End date (inclusive)

string format: date

external_ref

Replay key from the authoring source; a repeat with the same ref is a no-op on the existing row

string

max_length_of_stay

Maximum length of stay (nights)

integer

min_length_of_stay

Minimum length of stay (nights)

integer

posted_at

Business time the restriction was posted (defaults to now; must not be in the future)

string format: date-time

property_id

required

Property the restriction row is scoped to

string format: uuid

rate_plan_id

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

string format: uuid

room_type_id

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

string format: uuid

start_date

required

Start date

string format: date

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

Rollup deltas the action would contribute, computed and rolled back.

Media typeapplication/json

object

daily_rooms

required

Per (property, business_date) additive contribution to the rooms rollup.

Array<object>

object

business_date

required

string format: date

currency

ISO 4217, when the fold observed one.

string

property_id

required

string format: uuid

rooms_revenue_net_delta

required

Decimal, net rooms revenue delta.

string

rooms_sold_delta

required

integer format: int64

total_revenue_net_delta

required

Decimal, net total revenue delta.

string

Example^generated

{
  "daily_rooms": [
    {
      "business_date": "2026-04-15",
      "currency": "example",
      "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rooms_revenue_net_delta": "example",
      "rooms_sold_delta": 1,
      "total_revenue_net_delta": "example"
    }
  ]
}

Headers

Cache-Control

string

Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Validation error — the apply would be rejected.