Skip to content

What-if Propose action (rollup delta)

POST
/v1/actions/hospitality.action.propose_action/whatif
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.propose_action/whatif \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "confidence": "low", "context_snapshot": {}, "expires_at": "2026-04-15T12:00:00Z", "rationale_text": "example", "requires_confirmation_from": "guest", "subject_kind": "reservation", "subject_ref": "example", "target_action": "example", "target_params_snapshot": {} }, "return_modified": false }'

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

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
confidence
required
Agent confidence in the proposal
string
Allowed values: low medium high
context_snapshot
required
Frozen context the agent saw (bounded excerpts only)
object
key
additional properties
any
expires_at
When an unconfirmed proposal sweeps to `expired` (default 24h)
string format: date-time
rationale_text
required
Human-readable 'why', surfaced at confirmation time
string
requires_confirmation_from
required
Who must confirm before the kernel fires the action
string
Allowed values: guest staff approval_gate
subject_kind
required
The object class the action targets
string
Allowed values: reservation person folio charge stay venue other
subject_ref
required
Id of the subject object
string
target_action
required
The registered action this proposal intends to fire (ApiName form)
string
target_params_snapshot
required
Frozen proposed parameters for the target action
object
key
additional properties
any
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

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"
}
]
}
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

Validation error — the apply would be rejected.