Overview

This endpoint allows the Agent to make updates to existing Rate Sets associated with specific units. It enables adjustments to rates, intervals (weekly, daily, or monthly), Minimum or Maximum Length of Stay, and more as needed.

🚧

It is recommended to first use the Retrieve Rate Set function, then use the details from the Retrieve Rate Set Response to populate details for the Update Rate Set Request.

Endpoints Available

Path Parameters

Body Parameters

📘

weekly_daily_monthly

This parameter determines the interval type to be used within the Rate Set. The values to be used are:

0: Weekly
1: Daily
2: Monthly

"rate_Bands" Object Body Parameters

📘

Arrival/Departure Day Restrictions - Bitwise Representation

Arrival and departure day restrictions refer to specific rules or limitations set by property owners or managers regarding the days on which guests are allowed to arrive or depart from the property. To efficiently represent and enforce these restrictions, a bitwise representation is utilized, where each day of the week is assigned a corresponding bit value.

Bitwise representation allows for the encoding of multiple restrictions into a single integer value.

In this specific representation, Monday serves as the starting point, and each day of the week is assigned a unique bit position as follows:

Day	Bit Position	Byte
Monday	0	1
Tuesday	1	2
Wednesday	2	4
Thursday	3	8
Friday	4	16
Saturday	5	32
Sunday	6	64

To determine the arrival/departure day restrictions for a property, the relevant bit positions are set to 1 to indicate the allowed days and 0 to indicate the restricted days.

Examples:

1. If a property allows arrival and departure on Monday, Wednesday, and Sunday, the bitwise representation would be 1 + 4 + 64 = 69
2. If a property allows arrival and departures on Tuesday, Wednesday, and Sunday, the bitwise representation would be 2 + 4 + 64 = 70
3. For a property that restricts arrivals and departures on Monday, Friday, and Saturday, the bitwise representation would be 2 + 4 + 8 + 64 = 78
4. If a property allows check-ins and check-outs on all days, the bitwise representation would be
   1 + 2 + 4 + 8 + 16 + 32 + 64 = 127

Response Definitions

📘

weekly_daily_monthly

This parameter determines the interval type to be used within the Rate Set. The values to be used are:

0: Weekly
1: Daily
2: Monthly

"rate_Bands" Object

Sample Request

curl --location --request PUT 'https://api.ciiruspartners.com/v2024.07.31/rates/ratesets/72024' \
--header 'Authorization: Basic {APIUsername:APIPassword}' \
--data '{
  "rate_set_id": 72024,
  "mc_user_id": 42330,
  "set_name": "Test Property 1",
  "weekly_daily_monthly": 1,
  "includes_tax": false,
  "days_in_month": 30,
  "based_on_arrival_date_band_only": false,
  "currency": "USD",
  "minimum_nightly_rate": 0,
  "imported": "2023-09-15T00:00:00",
  "rate_bands": [
    {
      "rate_band_id": 1395092385,
      "property_id": 219264,
      "date_from": "2023-09-15T00:00:00",
      "date_to": "2023-11-21T00:00:00",
      "us_rate": 0,
      "rate_set_id": 72024,
      "minimum_nights_stay": 3,
      "arrival_days": 127,
      "floor_rate": 1,
      "minimum_nightly_rate": 0,
      "daily_rate": 1.5,
      "monthly_rate": 0,
      "departure_days": 127,
      "season_name": "Test1",
      "imported": "2023-09-15T00:00:00",
      "maximum_nights_stay": 0,
      "last_modified_by_staff_user_id": 0,
      "last_modified_by_user_id": 77520,
      "last_modified_by_ip_address": "9.8.8.7",
      "ip_address": "9.8.8.7"
    },
	...
  ],
  "last_modified_by_staff_user_id": 0,
  "last_modified_by_user_id": 77520,
  "ip_address": "9.8.8.7",
  "imported_from_calendar_sync_master": false,
  "is_flat_rate_model": false
}'

Sample Response

{
    "id": 72024,
    "set_name": "Test Property 1",
    "weekly_daily_monthly": 1,
    "use_default_floor_rate": false,
    "includes_tax": false,
    "days_in_month": 30,
    "based_on_arrival_date_band_only": false,
    "currency": "USD",
    "minimum_nightly_rate": 0,
    "rate_bands": [
        {
            "id": 1585490830,
            "unit_id": 0,
            "date_from": "2023-09-15T00:00:00",
            "date_to": "2023-11-21T00:00:00",
            "us_rate": 0,
            "rate_set_id": 72024,
            "missing_band": 0,
            "minimum_nights_stay": 3,
            "arrival_days": 127,
            "floor_rate": 1,
            "daily_rate": 1.5,
            "monthly_rate": 0,
            "departure_days": 127,
            "season_name": "Test1",
            "imported": "2023-09-15T00:00:00",
            "maximum_nights_stay": 0
        },
				...
    ],
    "mc_user_id": 42330
}