Update Reservation
How to use the Update Reservations function to update and manage reservations through the CiiRUS-API.
Overview
The Update Reservation function allows you to make changes to existing bookings using the CiiRUS-API. This guide outlines the necessary parameters and instructions to modify bookings within your application.
Endpoints Available
| Method | Endpoint | Description |
|---|---|---|
| PUT | v2024.07.31/reservations | Use this endpoint to modify reservations. |
| PUT | v2024.07.31/reservations/{reservation_id} | Use this endpoint to modify a specific reservation. |
Path Parameters
| Path Parameter | Required / Optional | Description |
|---|---|---|
| {reservation_id} | Required | The unique identifier for a reservation. |
Body Parameters
| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"id" | Required | The unique identifier for the booking to modify | int |
"management_company_user_id" | Optional | The unique identifier for the Supplier associated with the booking | int |
"unit_id" | Required | The unique identifier for the unit in the inventory for the reservation. | int |
"reference" | Optional | Indicates the external reference number for the reservation. | string |
"type" | Required | Indicates the type of booking, such as "confirmed" | string |
"details" | Required | An object containing specific details related to the reservation. | object |
"financials" | Optional | An object containing financial details related to the reservation. | array |
"last_modified" | Optional | The timestamp indicating the last modification made to the reservation. | int |
"error" | Optional | An optional object containing a custom error message. | object |
"details" Object Body Parameters
"details" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"quote_as_super_site_user_id" | Optional | Pass this to quote as a specific user ID. | int |
"arrival" | Required | The arrival date and time for the reservation. | date-time |
"departure" | Required | The departure date and time for the reservation. | date-time |
"added" | Optional | The timestamp indicating when the reservation was added. | date-time |
"expiration" | Optional | The timestamp indicating when the quote or tentative reservation expires. | date-time |
"cancelled_on" | Optional | The timestamp indicating when the reservation was cancelled. | date-time |
"scenario" | Optional | The reservation viewing scenario. | int |
"comments" | Optional | An object holding optional reservation comments. | array[objects] |
"guests" | Required | An array containing details about the guests of the reservation. | array[objects] |
"number_of_adults" | Optional | The number of adults included in the reservation. | int |
"number_of_children" | Optional | The number of children included in the reservation. | int |
"number_of_pets" | Optional | The number of pets included in the reservation. | int |
"category" | Optional | The reservation category name. | string |
"category_id" | Optional | The reservation category ID. | string |
"category_description" | Optional | The internal category description. | string |
"calendar_sync_category_id" | Optional | The category ID for the calendar sync agent. | int |
"secure_details" | Optional | An object containing property access details. | object |
"early_check_in" | Optional | A flag indicating if early check-in is desired/included for the reservation (true) or not (false). | boolean |
"late_check_out" | Optional | A flag indicating if late check-out is desired/included for the reservation (true) or not (false). | boolean |
"arrival_departure_info" | Optional | Custom notes or information related to arrival and/or departure. | string |
"owner_reservation" | Optional | A flag indicating if this is an owner's reservation (true) or not (false). | boolean |
"source" | Optional | Specifies the source of the booking | string |
"thread_id" | Optional | The unique identifier for the message thread. | string |
"airbnb_confirmation_code" | Optional | The unique identifier for the Airbnb reservation. | string |
"unit_name" | Optional | The name of the unit as configured by the management company. | string |
"comments" Object Body Parameters
"comments" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"text" | Optional | The text of the comment. | string |
"type" | Optional | The type of comment, e.g., "private". | string |
"guests" Object Body Parameters
"guests" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"id" | Optional | The CRM ID of the guest (if known). | int |
"type" | Required | The type of guest (e.g., "lead_guest"). | string |
"title" | Optional | The title of the guest. | string |
"first_name" | Required | First name of a party member | string |
"last_name" | Required | Last name of a party member | string |
"age" | Optional | Age of a party member | int |
"phone_numbers" | Optional | A list of phone numbers associated with the guest. | array[string] |
"email_addresses" | Optional | A list of email addresses associated with the guest. | array[string] |
"address" | Optional | The mailing address of the guest. | array[objects] |
"notes" | Optional | Additional notes to add against the guest. | string |
"allow_marketing_emails" | Optional | Indicates whether the guest allows marketing emails. | boolean |
"airbnb_guest_id" | Optional | The unique identifier for an Airbnb guest. | string |
"address" Object Body Parameters
"address" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"address_line_1" | Optional | The first line of the lead guest's mailing address. | string |
"address_line_2" | Optional | The second line of the lead guest's mailing address. | string |
"city" | Optional | The City of the lead guest's mailing address. | string |
"state_province" | Optional | The State or Province of the lead guest's mailing address. | string |
"country" | Optional | The Country of the lead guest's mailing address. | string |
"postal_code" | Optional | The ZIP or Postal Code of the lead guest's mailing address. | string |
"secure_details" Object Body Parameters
"secure_details" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"lock_box_code" | Optional | The lock box code for accessing the unit (if applicable). | string |
"gate_code" | Optional | The gate code for accessing the unit (if applicable). | string |
"alarm_code" | Optional | The alarm code for the unit's security system (if applicable). | string |
"wifi_ssid" | Optional | The Wi-Fi SSID for accessing the unit's internet (if applicable). | string |
"wifi_password" | Optional | The Wi-Fi password for accessing the unit's internet (if applicable). | string |
"lobby_code" | Optional | The lobby access code for the unit (if applicable). | string |
"fitness_room_code" | Optional | The access code for the fitness room (if applicable). | string |
"pool_access_code" | Optional | The access code for the pool area (if applicable). | string |
"beach_access_code" | Optional | The access code for the beach area (if applicable). | string |
"financials" Object Body Parameters
"financials" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"rate_set_id" | Optional | The unique identifier of the rate set used. | int |
"length_of_stay" | Optional | A flag indicating if length-of-stay pricing applies (true) or not (false). | boolean |
"pool_heat" | Optional | A flag indicating whether pool heat is included (true) or not (false). | boolean |
"discount_code" | Optional | The discount code to use (if applicable). | string |
"currency" | Optional | The currency in which the reservation is charged (e.g., USD). | string |
"merchant_of_record" | Optional | The entity responsible for processing the payment. | string |
"merchant_of_record_user" | Optional | The user ID of the merchant processing the payment. | int |
"charges" | Optional | An array containing line item charges related to the reservation. | array[objects] |
"payments" | Optional | A list of payments recorded for the reservation. | array[objects] |
"payment_schedule" | Optional | A list of scheduled payments for the reservation. | array[objects] |
"total_paid" | Optional | The total amount paid by the guest. | int |
"total_value" | Optional | The total cost of the reservation. | int |
"payment_taken_by" | Optional | The unique identifier of the user who took payment. | int |
"merchant_grantee_agent" | Optional | The unique identifier of the grantee agent. | int |
"merchant_grantee_supplier" | Optional | The unique identifier of the grantee supplier. | int |
"amount_paid" | Optional | The total amount paid by the guest. | int |
"mc_total_inclusive_tax" | Optional | The total amount, including taxes. | int |
"balance_due_amount" | Optional | The amount still owed by the guest. | int |
"balance_due_date" | Optional | A timestamp indicating the due date for the final balance. | date-time |
"charges" Object Body Parameters
"charges" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"item" | Optional | The name of the charge item. | string |
"id" | Optional | The unique identifier for the charge item. | string |
"code" | Optional | The code associated with the charge item. | string |
"applies_to_id" | Optional | The identifier specifying the charge item it applies to. | string |
"quantity" | Optional | The quantity of the charge item. | int |
"type" | Optional | The type of the charge item, which for example can be "rental" for rental rate, "cleaning_fee" for cleaning fee, "tax_one" for tax one, "tax_two" for tax two, or "extra" for additional fees. | string |
"value" | Optional | The value of the charge item. | int |
"payments" Object Body Parameters
"payments" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"amount" | Optional | The amount of the payment. | int |
"payment_date" | Optional | The date and time when the payment was made. | date-time |
"payment_schedule" Object Body Parameters
"payment_schedule" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"value" | Optional | The amount that is due for the reservation. | int |
"value_due" | Optional | The remaining balance due for the payment. | int |
"payment_type" | Optional | The type of payment (e.g., "down_payment"). | string |
"payment_status" | Optional | The status of the payment (e.g., "pending"). | string |
"due_date" | Optional | The scheduled due date of the payment. | date-time |
"error" Object Body Parameters
"error" Object Body Parameters| Parameter | Required / Optional | Description | Data Type |
|---|---|---|---|
"message" | Optional | The desired error message text, if any. | string |
Response Definition
| Response Item | Description | Data Type |
|---|---|---|
"id" | The unique identifier for the reservation. | int |
"unit_id" | The unique identifier for the unit associated with the reservation. | int |
"reference" | Indicates the external reference number for the reservation. | string |
"type" | The status of the reservation (e.g., "confirmed"). | string |
"management_company_user_id" | The unique identifier for the Supplier associated with the booking | int |
"details" | An object containing details about the associated reservation | object |
"financials" | An object containing financial details related to the reservation | object |
"last_modified" | The timestamp indicating the last modification made to the reservation. | date-time |
"error" | An optional object containing a custom error message. | object |
"details" Object
"details" Object| Parameter | Description | Data Type |
|---|---|---|
"quote_as_super_site_user_id" | Pass this to quote as a specific user ID. | int |
"arrival" | The arrival date and time for the reservation. | date-time |
"departure" | The departure date and time for the reservation. | date-time |
"added" | The timestamp indicating when the reservation was added. | date-time |
"expiration" | The timestamp indicating when the quote or tentative reservation expires. | date-time |
"cancelled_on" | The timestamp indicating when the reservation was cancelled. | date-time |
"scenario" | The reservation viewing scenario. | int |
"comments" | An object holding optional reservation comments. | array[objects] |
"guests" | An array containing details about the guests of the reservation. | array[objects] |
"number_of_adults" | The number of adults included in the reservation. | int |
"number_of_children" | The number of children included in the reservation. | int |
"number_of_pets" | The number of pets included in the reservation. | int |
"category" | The reservation category name. | string |
"category_id" | The reservation category ID. | string |
"category_description" | The internal category description. | string |
"calendar_sync_category_id" | The category ID for the calendar sync agent. | int |
"secure_details" | An object containing property access details. | object |
"early_check_in" | A flag indicating if early check-in is desired/included for the reservation (true) or not (false). | boolean |
"late_check_out" | A flag indicating if late check-out is desired/included for the reservation (true) or not (false). | boolean |
"arrival_departure_info" | Custom notes or information related to arrival and/or departure. | string |
"owner_reservation" | A flag indicating if this is an owner's reservation (true) or not (false). | boolean |
"source" | Specifies the source of the booking | string |
"thread_id" | The unique identifier for the message thread. | string |
"airbnb_confirmation_code" | The unique identifier for the Airbnb reservation. | string |
"unit_name" | The name of the unit as configured by the management company. | string |
"comments" Object
"comments" Object| Parameter | Description | Data Type |
|---|---|---|
"text" | The text of the comment. | string |
"type" | The type of comment, e.g., "private". | string |
"guests" Object
"guests" Object| Parameter | Description | Data Type |
|---|---|---|
"id" | The CRM ID of the guest (if known). | int |
"type" | The type of guest (e.g., "lead_guest"). | string |
"title" | The title of the guest. | string |
"first_name" | First name of a party member | string |
"last_name" | Last name of a party member | string |
"age" | Age of a party member | int |
"phone_numbers" | A list of phone numbers associated with the guest. | array[string] |
"email_addresses" | A list of email addresses associated with the guest. | array[string] |
"address" | The mailing address of the guest. | array[objects] |
"notes" | Additional notes to add against the guest. | string |
"allow_marketing_emails" | Indicates whether the guest allows marketing emails. | boolean |
"airbnb_guest_id" | The unique identifier for an Airbnb guest. | string |
"address" Object Body Parameters
"address" Object Body Parameters| Parameter | Description | Data Type |
|---|---|---|
"address_line_1" | The first line of the lead guest's mailing address. | string |
"address_line_2" | The second line of the lead guest's mailing address. | string |
"city" | The City of the lead guest's mailing address. | string |
"state_province" | The State or Province of the lead guest's mailing address. | string |
"country" | The Country of the lead guest's mailing address. | string |
"postal_code" | The ZIP or Postal Code of the lead guest's mailing address. | string |
"secure_details" Object Body Parameters
"secure_details" Object Body Parameters| Parameter | Description | Data Type |
|---|---|---|
"lock_box_code" | The lock box code for accessing the unit (if applicable). | string |
"gate_code" | The gate code for accessing the unit (if applicable). | string |
"alarm_code" | The alarm code for the unit's security system (if applicable). | string |
"wifi_ssid" | The Wi-Fi SSID for accessing the unit's internet (if applicable). | string |
"wifi_password" | The Wi-Fi password for accessing the unit's internet (if applicable). | string |
"lobby_code" | The lobby access code for the unit (if applicable). | string |
"fitness_room_code" | The access code for the fitness room (if applicable). | string |
"pool_access_code" | The access code for the pool area (if applicable). | string |
"beach_access_code" | The access code for the beach area (if applicable). | string |
"financials" Object Body Parameters
"financials" Object Body Parameters| Parameter | Description | Data Type |
|---|---|---|
"rate_set_id" | The unique identifier of the rate set used. | int |
"length_of_stay" | A flag indicating if length-of-stay pricing applies (true) or not (false). | boolean |
"pool_heat" | A flag indicating whether pool heat is included (true) or not (false). | boolean |
"discount_code" | The discount code to use (if applicable). | string |
"currency" | The currency in which the reservation is charged (e.g., USD). | string |
"merchant_of_record" | The entity responsible for processing the payment. | string |
"merchant_of_record_user" | The user ID of the merchant processing the payment. | int |
"charges" | An array containing line item charges related to the reservation. | array[objects] |
"payments" | A list of payments recorded for the reservation. | array[objects] |
"payment_schedule" | A list of scheduled payments for the reservation. | array[objects] |
"total_paid" | The total amount paid by the guest. | int |
"total_value" | The total cost of the reservation. | int |
"payment_taken_by" | The unique identifier of the user who took payment. | int |
"merchant_grantee_agent" | The unique identifier of the grantee agent. | int |
"merchant_grantee_supplier" | The unique identifier of the grantee supplier. | int |
"amount_paid" | The total amount paid by the guest. | int |
"mc_total_inclusive_tax" | The total amount, including taxes. | int |
"balance_due_amount" | The amount still owed by the guest. | int |
"balance_due_date" | A timestamp indicating the due date for the final balance. | date-time |
"charges" Object Body Parameters
"charges" Object Body Parameters| Parameter | Description | Data Type |
|---|---|---|
"item" | The name of the charge item. | string |
"id" | The unique identifier for the charge item. | string |
"code" | The code associated with the charge item. | string |
"applies_to_id" | The identifier specifying the charge item it applies to. | string |
"quantity" | The quantity of the charge item. | int |
"type" | The type of the charge item, which for example can be "rental" for rental rate, "cleaning_fee" for cleaning fee, "tax_one" for tax one, "tax_two" for tax two, or "extra" for additional fees. | string |
"value" | The value of the charge item. | int |
"payments" Object Body Parameters
"payments" Object Body Parameters| Parameter | Description | Data Type |
|---|---|---|
"amount" | The amount of the payment. | int |
"payment_date" | The date and time when the payment was made. | date-time |
"payment_schedule" Object Body Parameters
"payment_schedule" Object Body Parameters| Parameter | Description | Data Type |
|---|---|---|
"value" | The amount that is due for the reservation. | int |
"value_due" | The remaining balance due for the payment. | int |
"payment_type" | The type of payment (e.g., "down_payment"). | string |
"payment_status" | The status of the payment (e.g., "pending"). | string |
"due_date" | The scheduled due date of the payment. | date-time |
"error" Object
"error" Object| Parameter | Description | Data Type |
|---|---|---|
"message" | The error message text, if applicable. | string |
Sample Request
curl --location --request PUT 'https://api.ciiruspartners.com/v2024.07.31/reservations/41989952' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {APIUsername:APIPassword}' \
--data '{
"type": "confirmed",
"details": {
"arrival": "2026-04-24T16:00:00",
"departure": "2026-04-27T10:00:00",
"guests": [
{
"type": "lead_guest",
"first_name": "Test",
"last_name": "Test"
}
]
},
"unit_id": 219265
}
'
Sample Response
{
"id": 41989952,
"unit_id": 219265,
"reference": "",
"type": "confirmed",
"management_company_user_id": 42330,
"details": {
"arrival": "2026-04-24T16:00:00",
"departure": "2026-04-27T10:00:00",
"added": "2025-05-19T14:30:52.817",
"scenario": 6,
"comments": [
{
"text": "",
"type": "general"
}
],
"guests": [
{
"id": 8033700,
"type": "lead_guest",
"first_name": "Test",
"last_name": "Test",
"phone_numbers": [
""
],
"email_addresses": [
""
],
"customer_address": {
"address_line_1": "",
"address_line_2": "",
"city": "",
"state_province": "",
"country": "",
"postal_code": ""
}
}
],
"number_of_adults": 1,
"number_of_children": 0,
"category": "TOR",
"category_id": 16,
"category_description": "Tour Operator Reservation",
"secure_details": {
"lock_box_code": "5432",
"gate_code": "",
"alarm_code": "",
"wifi_ssid": "",
"wifi_password": "",
"lobby_code": "",
"fitness_room_code": "",
"pool_access_code": "",
"beach_access_code": ""
},
"early_check_in": false,
"late_check_out": false,
"owner_reservation": false,
"unit_name": "Test Property 2"
},
"financials": {
"currency": "USD",
"merchant_of_record": "agent",
"merchant_of_record_user": 45692,
"charges": [
{
"id": 7417,
"item": "Fee1",
"code": "Fee1",
"applies_to_id": "7417",
"quantity": 1,
"type": "extra",
"value": 495000000
},
{
"item": "Fee1 Tax 1",
"code": "Fee1",
"applies_to_id": "7417",
"quantity": 1,
"type": "tax_one",
"value": 34
},
{
"item": "Fee1 Tax 2",
"code": "Fee1",
"applies_to_id": "7417",
"quantity": 1,
"type": "tax_two",
"value": 24
},
{
"id": 7418,
"item": "Fee2",
"code": "Fee2",
"applies_to_id": "7418",
"quantity": 1,
"type": "extra",
"value": 1000000000
},
{
"item": "Fee2 Tax 1",
"code": "Fee2",
"applies_to_id": "7418",
"quantity": 1,
"type": "tax_one",
"value": 70
},
{
"item": "Fee2 Tax 2",
"code": "Fee2",
"applies_to_id": "7418",
"quantity": 1,
"type": "tax_two",
"value": 50
},
{
"id": 25011,
"item": "CP-STD",
"code": "CP-STD",
"applies_to_id": "25011",
"quantity": 1,
"type": "extra",
"value": 6500000000
},
{
"id": 21728,
"item": "ADI",
"code": "ADI",
"applies_to_id": "21728",
"quantity": 1,
"type": "extra",
"value": 7500000000
},
{
"id": 24651,
"item": "DAY",
"code": "DAY",
"applies_to_id": "24651",
"quantity": 1,
"type": "extra",
"value": 1750000000
},
{
"id": 7419,
"item": "Fee3",
"code": "Fee3",
"applies_to_id": "7419",
"quantity": 1,
"type": "extra",
"value": 1000000000
},
{
"item": "Fee3 Tax 1",
"code": "Fee3",
"applies_to_id": "7419",
"quantity": 1,
"type": "tax_one",
"value": 70
},
{
"item": "Fee3 Tax 2",
"code": "Fee3",
"applies_to_id": "7419",
"quantity": 1,
"type": "tax_two",
"value": 50
},
{
"id": 7422,
"item": "Fee6",
"code": "Fee6",
"applies_to_id": "7422",
"quantity": 1,
"type": "extra",
"value": 500000000
},
{
"item": "Fee6 Tax 1",
"code": "Fee6",
"applies_to_id": "7422",
"quantity": 1,
"type": "tax_one",
"value": 35
},
{
"item": "Fee6 Tax 2",
"code": "Fee6",
"applies_to_id": "7422",
"quantity": 1,
"type": "tax_two",
"value": 25
}
],
"payments": [],
"payment_schedule": [
{
"value": 15000000000,
"value_due": 15000000000,
"payment_type": "down_payment",
"payment_status": "scheduled",
"due_date": "2025-05-19T14:30:52.817"
},
{
"value": 4105000000,
"value_due": 4105000000,
"payment_type": "scheduled_payment",
"payment_status": "due",
"due_date": "2026-02-27T00:00:00"
}
],
"total_paid": 0,
"total_value": 19105000000
},
"last_modified": "2025-05-19T16:39:25.243"
}
Updated about 1 month ago