Skip to content
aerandil.com
GitHub

Validate Set cancellation policy (dry-run)

POST
/v1/actions/hospitality.action.set_cancellation_policy/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_cancellation_policy/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "applies_to_no_show": "inherit_last_tier", "code": "example", "currency": "example", "description": "example", "name": "example", "non_refundable": true, "notice_window_basis": "local_property_time", "tiers": [ { "applies_to": "cancellation", "penalty_amount": { "amount": "example", "currency": "example" }, "penalty_kind": "absolute", "penalty_nights": 1, "penalty_rate": "example", "trigger_offset_hours_before_arrival": 1 } ] }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Dry-run of apply_hospitality_action_set_cancellation_policy’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
applies_to_no_show
required
How a guest who never arrives is charged
string
Allowed values: inherit_last_tier separate_no_show_tier always_100_percent
code
required
Policy code — the terms' identity within the property
string
currency
required
Currency the penalties are denominated in (ISO 4217)
string format: iso-4217
description
Operator-facing description; also the wording a booking freezes
string
name
required
Display name, as the guest sees it
string
non_refundable
required
Advance-purchase shape: the whole stay is forfeit from the moment of booking, and `tiers` is ignored
boolean
notice_window_basis
required
Which clock the notice window is measured on
string
Allowed values: local_property_time guest_local_time utc
tiers
The penalty ladder (omit for a non-refundable or fully flexible policy)
Array<object>
object
applies_to
required
string
Allowed values: cancellation no_show both
penalty_amount
object
amount
required
string format: decimal
currency
required
string format: iso-4217
penalty_kind
required
string
Allowed values: absolute percent_of_total n_nights
penalty_nights
integer
penalty_rate
string format: decimal
trigger_offset_hours_before_arrival
required
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.property

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