Clear rate restrictions

POST

/v1/actions/hospitality.action.clear_rate_restrictions/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.clear_rate_restrictions/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "end_date": "2026-04-15", "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

Open a date window back up: every restriction reachable from the given scope(s) that intersects the window is spliced — deleted when the window swallows it, trimmed when it overhangs an edge, split into two rows when the window falls strictly inside it. The store stays canonical (no ‘open’ override rows shadowing ‘closed’ ones, the OPERA open-restriction shape this deliberately rejects), and the event log keeps the full author/splice history.

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

Step-up: a person (a User principal) needs a fresh desk step-up proof — Clearing restrictions deletes every one the named scope reaches in the window — or the call is refused 403 step_up_required before anything runs. Re-enter the passcode at POST /v1/desk/sessions/{id}/passcode and retry. Machine principals are not gated.

Authorizations

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

end_date

required

End date (inclusive)

string format: date

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: deleted modified 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": "deleted",
      "object_type": "hospitality.rate_restriction"
    }
  ]
}

403

step_up_required — a person applied this without a fresh desk step-up proof; nothing ran.

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.