Recommend rate

POST

/v1/actions/hospitality.action.recommend_rate/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.recommend_rate/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "business_date": "2026-04-15", "cadence": "nightly", "confidence": "low", "confidence_score": "example", "current_amount": { "amount": "example", "currency": "example" }, "expires_at": "2026-04-15T12:00:00Z", "expires_on": "2026-04-15", "factors_considered": [ "pickup_pace" ], "forecast_snapshot": {}, "occupancy": 1, "property_id": "example", "rationale_text": "example", "recommended_amount": { "amount": "example", "currency": "example" }, "room_type_id": "example", "run_id": "example", "target_field": "bar_anchor", "target_horizon_days": 1 }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.rate_plan" } }'

• Production API

Emit a typed rate recommendation. The agent payload (recommended_amount, current_amount, confidence, factors, forecast_snapshot, rationale) lands as a rate_recommendation row in suggested state with an immutable forecast snapshot captured at issue time. Decision lifecycle then flows through apply_rate_recommendation / reject_rate_recommendation / expire_rate_recommendations.

Effects: create hospitality.rate_recommendation; create hospitality.rate_recommendation_run; modify hospitality.rate_recommendation_run; link hospitality.link.recommendation_for_rate_plan; link hospitality.link.recommendation_for_room_type; link hospitality.link.recommendation_at_property; link hospitality.link.recommendation_part_of_run; link hospitality.link.run_for_property; link hospitality.link.recommendation_superseded_by; modify hospitality.rate_recommendation.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.recommend_rate:apply

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

business_date

required

Business date

string format: date

cadence

Run cadence (used only when opening a fresh run)

string

Allowed values: nightly intraday hourly event_triggered manual

confidence

required

Confidence ordinal

string

Allowed values: low medium high

confidence_score

Calibrated probability (optional)

string format: decimal

current_amount

required

Snapshot of the target amount at issue time

object

amount

required

string format: decimal

currency

required

string format: iso-4217

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)

object

key

additional properties

any

occupancy

required

Occupancy (adult count)

integer

property_id

required

Property the recommendation applies to

string

rationale_text

required

Human-readable explanation

string

recommended_amount

required

Proposed new amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

room_type_id

required

Room type the recommendation applies to

string

run_id

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

string

target_field

required

Target rate_per_night field

string

Allowed values: bar_anchor amount

target_horizon_days

Forecast horizon the run looked over

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.rate_plan

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

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.recommendation_for_rate_plan hospitality.link.recommendation_for_room_type hospitality.link.recommendation_at_property hospitality.link.recommendation_part_of_run hospitality.link.run_for_property hospitality.link.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.rate_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.recommendation_for_rate_plan"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.rate_recommendation"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.