Set rate restriction

POST

/v1/actions/hospitality.action.set_rate_restriction/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_rate_restriction/apply \
  --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

Author a sell restriction — stop-sell (closed), closed-to-arrival, closed-to-departure, MinLOS / MaxLOS — over a date range, scoped to a room type, a rate plan, or the pair (at least one must be given; restrictions compose as a conjunction with whatever else covers the date). At least one constraint must be set: an all-open restriction is refused rather than stored as noise. Opening a window back up is clear_rate_restrictions, which splices existing rows rather than stacking an ‘open’ override, or lift_rate_restriction, which takes one authored row off the board and keeps it as history. posted_at is business time (defaults to now); external_ref is a replay key — a second set carrying the same ref lands on the existing row, lifted or not, and writes nothing.

Effects: create hospitality.rate_restriction; link hospitality.link.room_type_has_restriction; link hospitality.link.rate_plan_has_restriction.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.set_rate_restriction: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

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

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.room_type_has_restriction hospitality.link.rate_plan_has_restriction

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

object_type

required

Allowed values: hospitality.rate_restriction

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.room_type_has_restriction"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.rate_restriction"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.