CLcloudbeds
Smart Policy Exceptions

Partially update a policy exception.

patch/smart-policies/v1/exceptions/{exceptionId}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/smart-policies/v1/exceptions/{exceptionId}
  • Auth
    OAuth 2
    Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
    Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: write:rate

Path parameters

exceptionIdExceptionId required(unresolved $ref)

Policy exception ID.

Headers

x-property-idstring required
Example:1,2,3

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

Request body

exceptionIdstring required

Policy exception ID.

policyRootIdinteger nullable

Smart policy root ID.

namestring nullable

Internal name for this exception.

enabledboolean nullable

Whether the exception is enabled.

Example request

{
  "exceptionId": "5001",
  "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

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

Changes

No recorded changes to this operation across all 1 revision of this API.