Room Set (Create/Update) API
Last updated
Was this helpful?
Last updated
Was this helpful?
This endpoint is used to create or update room details within a property unit. When a request is made to this endpoint, it processes the provided room configuration data and either creates a new room unit or updates an existing one.
POST
app-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key. for authorization. Required for authentication.
Content-Type
string
Yes
Must be set to application/json
.
hotel_id
string (Required)
Specifies the hotel ID for the property.
channel_hotel_id
string (Required)
Specifies the channel-specific hotel ID for the property.
language_code
string (Required)
The language_code
parameter specifies the language in which the response should be provided or the language preference for the data.
room_request
object (Required)
Contains the room-related configurations and details for the unit.
configuration
object (Required)
Contains the configuration details for the unit type.
unit_type_id
enumerated string (Required)
Specifies the unit type ID (for example, "1" for apartment).
rooms
array (Required)
Contains details of the room types supported by the unit. An array of room objects.
type
enumerated string (Required)
Specifies the room type supported by the unit.
bed_configurations
object (Conditional)
Contains details of the bed configuration for the room.
beds
array (Required)
Contains the bed type and total number of beds available in the room.
bed_type_id
enumerated integer (Required)
Specifies the bed type ID.
bed_count
integer (Required)
Specifies the total number of beds of the specified type in the room.
is_default_configuration
boolean (Required)
Specifies if the bed configuration is the default configuration for the room.
unit_name_id
string (Required)
Specifies the unit name ID that is part of the unit type.
number_of_units
integer (Optional)
Specifies the total number of units available at the property.
smoking_policy
enumerated string (Optional)
Specifies the smoking policy in the unit.
size
object (Optional)
Contains the unit size details.
value
integer (Required)
Specifies the unit size in the chosen unit.
unit
enumerated string (Required)
Specifies the unit of measurement to represent the unit size.
partner_reference_name
string (Optional)
Specifies a custom unit name visible in the extranet and API response.
room_located_on_floors
array (Optional)
Specifies the floors where the unit is located. This is an array of integers representing the floor numbers.
occupancy
object (Optional)
Contains the occupancy details for the unit.
max_guests
integer (Optional)
Specifies the maximum guest occupancy for the unit.
max_adults
integer (Optional)
Specifies the maximum adult occupancy for the unit.
max_children
integer (Optional)
Specifies the maximum child occupancy for the unit.
max_children_that_pay_children_rate
integer (Optional)
Specifies the maximum number of children eligible for the child rate.
extra_beds_configuration
object (Optional)
Contains details for extra bed configuration in the unit.
extra_beds
integer (Optional)
Specifies the number of extra beds available on request per unit.
cribs
integer (Optional)
Specifies the number of cribs available on request per unit.
is_crib_and_extra_bed_allowed
boolean (Optional)
Specifies whether both cribs and extra beds are allowed to be requested simultaneously for the unit.
Request Body to Create Room
Request Body to Update Room
data
object
Contains details of the unit created.
channel_room_id
integer
Specifies the channel-specific room ID for the unit.
unit_id
string
Specifies the unit ID.
configuration
object
Contains the unit configuration.
unit_type_id
enumerated string
Specifies the unit type ID.
rooms
array
Contains the room details provided the unit type supports rooms (also known as subrooms).
type
enumerated string
Specifies the room type supported by the unit type.
bed_configurations
object
Contains the details of the bed available in the room.
beds
array
Contains the bed type and the total number of beds.
bed_type_id
enumerated integer
Specifies the bed type ID that is supported by the unit type.
bed_count
integer
Specifies the total number of beds available in the unit/room.
is_default_configuration
boolean
Specifies whether the specified bed configuration is default for the unit/room.
unit_name_id
string
Specifies the unit name ID that is part of the unit type.
number_of_units
integer
Specifies the total number of rooms available at the property for the specified room type.
smoking_policy
enumerated string
Specifies the smoking policy in the room.
size
object
Contains the unit size details.
value
integer
Specifies the unit size in the chosen unit.
unit
enumerated string
Specifies the unit of measurement to represent the unit size.
partner_reference_name
string
Specifies a custom unit name that is visible in the extranet and in the API response.
floor_numbers_located_on
array
Specifies the floor where the unit is located.
occupancy
object
Contains the occupancy details of the unit.
max_guests
integer
Specifies the maximum guest occupancy for the unit.
max_adults
integer
Specifies the maximum adult occupancy for the unit.
max_children
integer
Specifies the maximum child occupancy for the unit.
max_children_that_pay_children_rate
integer
Specifies the maximum number of children eligible for the child rate.
extra_beds_configuration
object
Contains the extra beds details for the unit.
extra_beds
integer
Specifies the total number of extra beds available on request per room/unit.
cribs
integer
Specifies the total number of extra cribs available on request per room/unit.
is_crib_and_extra_bed_allowed
integer
Specifies whether guests have the option of requesting both the extra bed and crib in the room/unit.
Message
string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
Ruid
string
Specifies the unique request ID.
Sample Error Response 1
Sample Error Response 2
Sample Error Response 3
When you pass invalid value for bedding type:
Error Response Body Elements
Status
string
Indicates the result of the API call, which will be always "Fail"
in case of an error response.
Error
array
Array that contains details about any errors that occurred during the API call. Each object in the Errors
array contains the following properties:
Code
string
Specific error code that helps identify the type of error.
ShortText
string
A short description of the error.
Message
string
A message providing more information about the error.
Ruid
string
A unique identifier for tracking the request.