v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Smart Policy Exceptions

Create a new policy exception.

post/smart-policies/v1/exceptions

Headers

x-property-idstring required

Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Request body

policyRootIdinteger required

Smart policy root ID.

namestring required

Internal name for this exception.

enabledboolean

Whether the exception is enabled.

Example request

{
  "policyRootId": 1001,
  "intervals": [
    {
      "startDate": "2024-01-01",
      "endDate": "2024-01-31",
      "day0": true,
      "day1": true,
      "day2": true,
      "day3": true,
      "day4": true,
      "day5": true,
      "day6": true
    }
  ],
  "rates": [
    {
      "packageId": 123,
      "roomTypeId": 456
    }
  ],
  "name": "Winter holiday exception",
  "enabled": true
}

Response

Created policy exception.

idstring

propertyIdstring

namestring

policyRootIdstring

enabledboolean

createdBystring

createdAtstring date-time

updatedAtstring date-time

Example response

{
  "id": "5001",
  "propertyId": "1234",
  "name": "Winter holiday exception",
  "policyRootId": "1001",
  "enabled": true,
  "createdBy": "9876",
  "createdAt": "2024-01-01T10:00:00+00:00",
  "updatedAt": "2024-01-15T12:00:00+00:00",
  "intervals": [
    {
      "startDate": "2024-01-01",
      "endDate": "2024-01-31",
      "day0": true,
      "day1": true,
      "day2": true,
      "day3": true,
      "day4": true,
      "day5": true,
      "day6": true
    }
  ],
  "rates": [
    {
      "packageId": "123",
      "roomTypeId": "456"
    }
  ]
}