Skip to content
aerandil.com
GitHub

Validate Recommend rate (dry-run)

POST
/v1/actions/hospitality.action.recommend_rate/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.recommend_rate/validate \
  --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" } }'

Dry-run of apply_hospitality_action_recommend_rate’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

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

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}