Create/Update Facility
Last updated
Was this helpful?
Last updated
Was this helpful?
This endpoint allows you to create or update the facilities of a property or a specific room within a property. You can specify the availability and additional details such as parking information, restaurant details, internet connectivity, and more. The request body accepts various facility details, and in case of updates, you can provide an instance_id
to modify an existing instance.
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)
The unique property ID as assigned by the provider upon creation of the property.
channel_hotel_id
string (Required)
The unique id for the hotel on the specific channel.
channel_room_id
string (Optional)
If you are setting up the facility for the particular room then it's required otherwise this field is optional.
A unique identifier for the room within the specific channel (for example, a property management system or booking platform). This ID allows the system to identify and update the facilities for a particular room in the hotel.
facilities
array (Required)
An array of objects, each representing a facility for the property (or individual rooms). The array defines the available facilities and their details such as availability, instances, and configuration.
facility_id
string (Required)
The unique identifier for a facility type (e.g., parking, restaurant, pool, etc.).
is_available
boolean (Required)
Indicates whether this facility is available.
instances
array (Optional)
A list of instances under this facility type. Each instance may have specific configurations.
instance_id
string (Optional)
The unique identifier for a particular instance (used for updates).
parking_details
object (Required for parking facilities)
Details about the parking setup.
name
string (Optional)
The name of the parking lot.
parking_location
enum (Optional)
The location of the parking facility.
parking_access
enum (Optional)
Indicates access restrictions. For example, "ONLY_GUESTS" means that only hotel guests can use the parking.
parking_reservation
enum (Optional)
Specifies if reservation is needed for parking.
payment_details
object (Optional)
Defines the payment mode for the parking service.
charge_mode
enum (Optional)
The charge mode for the facility, such as "FREE" or "PAID".
temporarily_closed_details
object (Required for Temporary Closed Facilities)
Contains a list of periods when this facility is closed.
closed
array
An array of closed periods.
start_date
epoch_seconds
The start of the closed period (in Unix timestamp format).
end_date
epoch_seconds
The end of the closed period (in Unix timestamp format).
indicates that this facility is available.
surcharge_details
object (Optional)
Specifies surcharge details for this facility.
surcharge_type
string
Defines the type of surcharge applied. For example, "DEFAULT" might be the standard surcharge for this facility.
Indicates that this facility is currently not available.
schedule_details
object
Defines the operating schedule for this facility.
schedule
object
A list of schedule periods.
from
object
The start time of the schedule period.
to
object
The end time of the schedule period.
day_of_week
enum
The day of the week on which this schedule applies.
on_site_details
object
Specifies whether the facility is on-site or off-site.
onsite_type
enum
Defines whether the facility is "ON_SITE" or "OFFSITE".
restaurant_details
object
Contains details about the restaurant.
name
string
The name of the restaurant.
meal_types_list
array
A list of meal types provided, such as HALAL or VEGETARIAN.
cuisines_list
array
A list of cuisines offered.
swimming_pool_details
object
Contains information about the swimming pool.
name
string
The name of the pool.
swimming_pool_type
enum
Defines the type of the swimming pool.
internet_details
object
Contains details about internet availability.
area
enum
Specifies the area where internet is available.
type
enum
Specifies the type of internet service.
Use the below sample codes to add the provided facilities:
parking_details
object (Required for parking facilities)
Details about the parking setup.
name
string (Optional)
The name of the parking lot.
parking_location
enum (Optional)
The location of the parking facility.
parking_access
enum (Optional)
Indicates access restrictions. For example, "ONLY_GUESTS" means that only hotel guests can use the parking.
parking_reservation
enum (Optional)
Specifies if reservation is needed for parking.
payment_details
object (Optional)
Defines the payment mode for the parking service.
charge_mode
enum (Optional)
The charge mode for the facility, such as "FREE" or "PAID".
temporarily_closed_details
object (Required for Temporary Closed Facilities)
Contains a list of periods when this facility is closed.
closed
array
An array of closed periods.
start_date
epoch_seconds
The start of the closed period (in Unix timestamp format).
end_date
epoch_seconds
The end of the closed period (in Unix timestamp format).
indicates that this facility is available.
surcharge_details
object (Optional)
Specifies surcharge details for this facility.
surcharge_type
string
Defines the type of surcharge applied. For example, "DEFAULT" might be the standard surcharge for this facility.
Indicates that this facility is currently not available.
schedule_details
object
Defines the operating schedule for this facility.
schedule
object
A list of schedule periods.
from
object
The start time of the schedule period.
to
object
The end time of the schedule period.
day_of_week
enum
The day of the week on which this schedule applies.
on_site_details
object
Specifies whether the facility is on-site or off-site.
onsite_type
enum
Defines whether the facility is "ON_SITE" or "OFFSITE".
restaurant_details
object
Contains details about the restaurant.
name
string
The name of the restaurant.
meal_types_list
array
A list of meal types provided, such as HALAL or VEGETARIAN.
cuisines_list
array
A list of cuisines offered.
swimming_pool_details
object
Contains information about the swimming pool.
name
string
The name of the pool.
swimming_pool_type
enum
Defines the type of the swimming pool.
internet_details
object
Contains details about internet availability.
area
enum
Specifies the area where internet is available.
type
enum
Specifies the type of internet service.
Indicates the result of the API call.
Data
array
An array containing data related to the successful image creation. This typically includes identifiers for the created images.
Message
string
Provides a brief message about the outcome. Here, it states "Successfully fetch details," confirming that the requested information was retrieved.
Ruid
string
A unique identifier for tracking the request.
Sample Error Response 1
Sample Error Response 2
Sample Error Response 3
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.