Rename a policy or replace its tiers

Changing the preset or tiers bumps the version. Existing reservations keep the terms they were booked under.

Authorization

x-calry-api-key

x-calry-api-key<token>

In: header

Path Parameters

id*string

Header Parameters

x-calry-tenant-id?string

Tenant (host) whose policies to manage. If not provided, the default tenant is used.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Display name. Defaults to the preset's name.

preset?string

Start from a preset; its tiers are written for you. Send this or tiers.

Value in"FLEXIBLE" | "MODERATE" | "STRICT" | "NON_REFUNDABLE"

tiers?array<>

Custom refund steps. An empty list is non-refundable. Closer to check-in the refund may only stay the same or drop.

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/cancellation-policies/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Summer strict",
  "preset": "FLEXIBLE",
  "tiers": [
    {
      "daysBeforeCheckIn": 7,
      "refundPercentage": 50
    }
  ],
  "version": 1,
  "archivedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}