Skip to content
aerandil.com
GitHub

What-if Set availability (rollup delta)

POST
/v1/actions/hospitality.action.set_availability/whatif
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_availability/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "days_of_week": [ "monday" ], "end_date": "2026-04-15", "oversell_ceiling": 1, "oversell_limit": 1, "physical": 1, "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "room_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sellable": 1, "sold": 1, "start_date": "2026-04-15" }, "return_modified": false }'

What-if projection of apply_hospitality_action_set_availability — 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_availability:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
days_of_week
Days of week the pattern applies to (defaults to all seven)
Array<string>
Allowed values: monday tuesday wednesday thursday friday saturday sunday
end_date
required
End date (inclusive)
string format: date
oversell_ceiling
Oversell ceiling

The most oversell headroom a sell-limit recommendation may set (the guardrail; omitted, the declared oversell_limit is the ceiling)

integer
oversell_limit
Oversell headroom above sellable
integer
physical
required
Physical room count
integer
property_id
required
Property
string format: uuid
room_type_id
required
Room type
string format: uuid
sellable
required
Sellable room count
integer
sold
Initial sold count for rows this call mints (default 0; existing rows keep their own)
integer
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

Section titled “Responses”

200

Section titled “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
Examplegenerated
{
  "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

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Section titled “422”

Validation error — the apply would be rejected.