Overview

The Update Units request allows the Agent to manage the enablement status of the Inventory. With this request, partners can efficiently update the enablement status of specific units, granting or revoking access to the associated inventory.

The Update Units request allows API users to gain access to, or withdraw access from, the available inventory. By updating the enablement status of units, partners can effectively control which properties are accessible for integration and further utilization.

🚧
Note
The use of this request is the same as clicking "Enabled?" in the App. By using this function, you are agreeing to do business and abide by the terms of your direct agreement with the Property Manager for each respective property.

Endpoints Available

Method	Endpoint	Description
PUT	v2024.07.31/units	Updates the enablement status of specified units in the inventory.
PUT	v2024.07.31/units/{unit_id}	Updates the enablement status of a specific unit in the inventory.

Path Parameters

Path Parameter	Required / Optional	Description
{unit_id}	Required	Unique Identifier for a unit in the inventory.

Query String Parameters

Parameter	Required / Optional	Description	Data Type
enabled	Optional	Sets the enablement status of Inventory. Overridden by the `"enabled"` Body Parameter.	boolean

Body Parameters

Object	Required / Optional	Description	Data Type
`"unit_id"`	Required	Unique Identifier for Unit in Inventory	int
`"enabled"`	Optional	Enable the connection of the unit in the inventory (`true`) or disable the connection of the unit in the inventory (`false`).	boolean

Response Definition

Response Item	Description	Data Type
`"units"`	An array of unit objects and the details associated with each unit.	array[objects]

`"units"` Object

Response Item	Description	Data Type
`"unit_id"`	The unique identifier for the unit.	int
`"unit_name"`	The display name of the unit.	string
`"enabled"`	A flag indicating whether the unit is enabled (`true`) or disabled (`false`) by both the supplier and the agent.	boolean
`"native"`	A flag indicating whether the unit is native to the Agent (`true`) or not (`false`). Native units are managed directly within the system	boolean
`"agent_enabled"`	A flag indicating whether the unit is enabled (`true`) or disabled (`false`) by the agent.	boolean
`"supplier_enabled"`	A flag indicating whether the unit is enabled (`true`) or disabled (`false`) by the supplier.	boolean
`"clone"`	A flag indicating whether the unit is a clone of another unit (`true`) or not (`false`).	boolean
`"deleted"`	A flag indicating whether the unit has been marked as deleted (`true`) or not (`false`).	boolean
`"online_booking_enabled"`	A flag indicating whether online booking is enabled for the unit (`true`) or not (`false`).	boolean
`"booking_fence"`	The number of days in advance a booking must be made for the unit.	int
`"gap_days"`	The minimum number of days required between bookings for the unit.	int
`"include_mandatory_extras"`	A flag indicating whether mandatory extras are included in the booking for this unit (true) or not (false). Mandatory extras are additional charges or services that must be included with the booking	boolean
`"merchant_of_record"`	Indicates the entity that acts as the Merchant of Record for the unit. Possible values can be `"management_company"` or `"agent"`.	string
`"relationship_to_unit"`	The relationship of the current user to the unit (e.g., `"supersite_agent"`).	string
`"timezone"`	Time zone of the unit location (IANA format).	string
`"owner_user_id"`	The unique identifier for the owner of the unit.	int
`"owner_name"`	The name of the unit owner.	string
`"management_company_rate_set_id"`	The ID of the management company’s default rate set that is assigned to your agent.	int
`"management_company_user_id"`	The unique identifier for the management company of the unit.	int
`"master_unit_rate_set_use_nightly_floor_rates"`	A flag indicating whether nightly floor rates are used in the master rate set (`true`) or not (`false`).	boolean
`"rent_ready_date"`	The date that the unit was or will be ready for rent (ISO 8601 format).	date-time
`"community_id"`	The unique ID of the community the unit belongs to. The item can be used to search and/or categorize units by location.	int
`"community_name"`	The name of the community.	string
`"minimum_nights_stay"`	The default minimum number of nights required for a booking for the unit.	int
`"last_unit_update_date"`	The date and time of the last update to the unit itself.	date-time
`"last_reservation_update_date"`	The date and time of the last reservation update for this unit.	date-time
`"address"`	The physical address of the unit.	array[objects]
`"bedrooms"`	The number of bedrooms of the unit (can be zero).	int
`"bathrooms"`	The number of bathrooms in the unit (can include partials).	float
`"franchisee"`	The franchisee name or label (may be empty).	string
`"airbnb"`	An array containing Airbnb-specific listing data (see below).	array[objects]
`"error"`	The error message related to the unit, if any (see below).	array[objects]

❗️
Properties will NOT be bookable and will NOT display as active until Enabled.

`"address"` Object

Response Item	Description	Data Type
`"address_line_1"`	The primary street address of the unit.	string
`"address_line_2"`	The secondary address information (e.g., unit, suite).	string
`"city"`	The City where the unit is located.	string
`"state_province"`	The State or province of the unit’s address.	string
`"postal_code"`	The ZIP or postal code of the unit.	string

`"airbnb"` Object

Response Item	Description	Data Type
`"host_id"`	The Airbnb host account ID associated with the unit.	string
`"listing_id"`	The Airbnb listing ID of the unit.	string
`"request_to_book_on_short_notice"`	A flag indicating whether short-notice booking requests are allowed (`true`) or not (`false`).	boolean
`"short_term_cancelation_policy"`	The Airbnb short-term cancellation policy assigned to the unit.	string
`"publish_listing"`	A flag indicating whether the listing is published/live on Airbnb (`true`) or not (`false`).	boolean

`"error"` Object

Response Item	Description	Data Type
`"message"`	The error message returned if applicable (e.g., when enabling a unit fails).	string

Sample Request

curl --location --request PUT 'https://api.ciiruspartners.com/v2024.07.31/units' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {APIUsername:APIPassword}' \
--data '[
  {
    "enabled": true,
    "unit_id": 219264
  },
  {
    "enabled": true,
    "unit_id": 219265
  }
]'

Sample Response

{
    "units": [
        {
            "unit_id": 219264,
            "unit_name": "Test Property 1",
            "enabled": true,
            "native": false,
            "agent_enabled": true,
            "supplier_enabled": true,
            "clone": false,
            "deleted": false,
            "online_booking_enabled": true,
            "booking_fence": 1,
            "gap_days": 2,
            "include_mandatory_extras": true,
            "merchant_of_record": "management_company",
            "relationship_to_unit": "supersite_agent",
            "timezone": "America/New_York",
            "owner_user_id": 42334,
            "owner_name": "API Owner",
            "management_company_rate_set_id": 129286,
            "management_company_user_id": 42330,
            "master_unit_rate_set_use_nightly_floor_rates": false,
            "rent_ready_date": "2017-01-18T00:00:00",
            "community_id": 17511,
            "community_name": "Encore Resort at Reunion",
            "minimum_nights_stay": 1,
            "last_unit_update_date": "2025-04-30T11:45:09.757",
            "last_reservation_update_date": "2025-04-29T17:20:54.41",
            "address": {
                "address_line_1": "1012 Emmette St",
                "address_line_2": "Suite A",
                "city": "Kissimmee",
                "state_province": "Fl",
                "postal_code": "34741"
            },
            "bedrooms": 0,
            "bathrooms": 2.0,
            "franchisee": "",
            "airbnb": {
                "host_id": "431444876",
                "listing_id": "739807228214052587",
                "request_to_book_on_short_notice": false,
                "short_term_cancelation_policy": "flexible",
                "publish_listing": true
            },
            "error": {
                "message": "Unit is already enabled."
            }
        },
        {
            "unit_id": 219265,
            "unit_name": "Test Property 2",
            "enabled": true,
            "native": false,
            "agent_enabled": true,
            "supplier_enabled": true,
            "clone": false,
            "deleted": false,
            "online_booking_enabled": true,
            "booking_fence": 0,
            "gap_days": 0,
            "include_mandatory_extras": true,
            "merchant_of_record": "management_company",
            "relationship_to_unit": "supersite_agent",
            "timezone": "America/New_York",
            "owner_user_id": 42334,
            "owner_name": "API Owner",
            "management_company_rate_set_id": 129286,
            "management_company_user_id": 42330,
            "master_unit_rate_set_use_nightly_floor_rates": false,
            "rent_ready_date": "2017-01-18T00:00:00",
            "community_id": 124,
            "community_name": "Terra Verde Resort",
            "minimum_nights_stay": 2,
            "last_unit_update_date": "2025-04-30T11:45:09.757",
            "last_reservation_update_date": "2025-04-21T02:23:08.41",
            "address": {
                "address_line_1": "1014 Emmette St",
                "address_line_2": "Suite B",
                "city": "Kissimmee",
                "state_province": "Fl",
                "postal_code": "34741"
            },
            "bedrooms": 12,
            "bathrooms": 8.5
            }
        }
    ]
}

Overview

🚧Note

Endpoints Available

Path Parameters

Query String Parameters

Body Parameters

Response Definition

"units" Object

❗️

"address" Object

"airbnb" Object

"error" Object

Sample Request

Sample Response

🚧
Note

`"units"` Object

`"address"` Object

`"airbnb"` Object

`"error"` Object