This endpoint enables you to delete a specific message set by the hotelier for a property.
POST
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.
message_id string (Required)
The unique id for the message.
Success Response Body Elements
Status string
Indicates the overall status of the request. In this case, "Success" means the operation was completed successfully.
Data object
Contains the main content of the response, specifically relevant information fetched by the API.
Message string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
Ruid string
A unique request identifier.
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.
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/profile/deleteHotelierMessageapp-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key for authorization.
Content-Type
string
Yes
Must be set to application/json.
-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json{
"hotel_id": "NT7",
"channel_hotel_id": "12837615",
"message_id":"454064949" //required
}{
"Status": "Success",
"Data": [],
"Message": "Hotelier-Message Remove Successfully",
"Ruid": "230d66e9-ad06-42bd-aca8-be0b1939b85e"
}{
"Errors": [
{
"Code": "400",
"ShortText": "HotelCode: Invalid HotelCode ('NT711')"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Errors": [
{
"Code": "573",
"ShortText": "channel-mapping not found for this property!"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Status": "Fail",
"Errors": [],
"Message": "Not found",
"Ruid": "xxxxxx"
}This endpoint allows users to set or update the profile of a hotel property. It requires essential identifiers such as hotel_id and channel_hotel_id, along with details about the property, including its location, dates for renting and renovation, and optional images.
POST
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.
host_location string (Required)
Specifies the location type of the host.
name_or_company string (Optional)
The name of the hotel or company. This field is optional and can be used for branding purposes or internal identification.
renting_date string (Optional)
The date when the property will be available for rent.
renovating_date string (Optional)
The date when renovations are expected to be completed.
built_date string (Optional)
The date when the property was built
is_company_profile integer (Optional)
Indicates whether the profile is for a company.
image array (Optional)
An array of image objects associated with the property.
url string (Required)
The URL of the image. It's required if Images is present.
Status string
Indicates the overall status of the request. In this case, "Success" means the operation was completed successfully.
Data array
An array containing data related to the successful image creation. This typically includes identifiers for the created images.
Message string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
Ruid string
A unique request identifier.
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 associated with the error code.
Message string
A message providing more information about the error.
This endpoint allows you to configure and update messages from the hotelier associated with a specific property.
POST
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.
hotelier_message object (Required)
This object contains the details of the message from the hotelier.
language_code string (Required)
The language code for the hotelier's message, typically in ISO 639-1 format with a region code.
message_type string (Required)
The type of the message being sent by the hotelier. This helps categorize the message.
message string (Required)
The content of the message from the hotelier. This should be a string containing the actual message text.
Status string
Indicates the overall status of the request. In this case, "Success" means the operation was completed successfully.
Data array
An array containing data related to the successful image creation. This typically includes identifiers for the created images.
Message string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
Ruid string
A unique request identifier.
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.
This endpoint allows you to fetch the current messages set by the hotelier for a specific property.
POST
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.
Success Response Body Elements
Status string
Indicates the overall status of the request. In this case, "Success" means the operation was completed successfully.
Data object
Contains the main content of the response, specifically relevant information fetched by the API.
hotelier_messages array
A list of messages from the hotelier. Each message contains details such as:
id integer
A unique identifier for the message.
language_code string
Indicates the language of the message.
message_type string
Classifies the type of message.
message string
The actual content of the message.
Message string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
Ruid string
A unique request identifier.
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.
This endpoint allows you to retrive the property profile.
POST
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.
Status string
Indicates the overall status of the request. In this case, "Success" means the operation was completed successfully.
Data array
An array containing data related to the successful image creation. This typically includes identifiers for the created images.
host_location string
Specifies the location type of the host.
name_or_company string
The name of the hotel or company. This field is optional and can be used for branding purposes or internal identification.
renting_date string
The date when the property will be available for rent.
renovating_date string
The date when renovations are expected to be completed.
built_date string
The date when the property was built.
is_company_profile integer
Indicates whether the profile is for a company.
Message string
A message receives within the response body. This will generally be an empty string if no additional information is needed.
Ruid string
A unique request identifier.
Sample Error Response 1
Sample Error Response 2
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 associated with the error code.
Message string
A message providing more information about the error.
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/profile/setHotelierMessagehttps://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/profile/retrieveHotelierMessagehttps://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/profile/retrieveProfileapp-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key for authorization.
Content-Type
string
Yes
Must be set to application/json.
app-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key for authorization.
Content-Type
string
Yes
Must be set to application/json.
app-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key for authorization.
Content-Type
string
Yes
Must be set to application/json.
-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json{
"hotel_id": "NT7",
"channel_hotel_id": "12837615",
"hotelier_message": {
"language_code": "en-gb",
"message_type":"owner_info",
"message": "Our owner is not available for 15 days"
}
}{
"Status": "Success",
"Data": [],
"Message": "Hotelier Message Set Successfully",
"Ruid": "5cf60f13-bccf-4a11-a277-5b3510052014"
}{
"Errors": [
{
"Code": "400",
"ShortText": "HotelCode: Invalid HotelCode ('NT711')"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Errors": [
{
"Code": "573",
"ShortText": "channel-mapping not found for this property!"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Status": "Fail",
"Errors": [],
"Message": "Access denied",
"Ruid": "xxxxxx"
}-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json{
"hotel_id": "NT7",
"channel_hotel_id": "12837615"
}{
"Status": "Success",
"Data": {
"hotelier_messages": [
{
"id": 454064949,
"language_code": "en-gb",
"message_type": "owner_info",
"message": "Our owner is not available for 15 days"
}
]
},
"Message": "Property Hotelier-Message Fetched Successfully",
"Ruid": "023ae3a7-d4dd-4cda-9a90-08144d989dc3"
}{
"Status": "Success",
"Data": {
"hotelier_messages": []
},
"Message": "Property Hotelier-Message Fetched Successfully",
"Ruid": "023ae3a7-d4dd-4cda-9a90-08144d989dc3"
}{
"Errors": [
{
"Code": "400",
"ShortText": "HotelCode: Invalid HotelCode ('NT711')"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Errors": [
{
"Code": "573",
"ShortText": "channel-mapping not found for this property!"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Status": "Fail",
"Errors": [],
"Message": "Access denied",
"Ruid": "xxxxxx"
}-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json{
"hotel_id": "NT7",
"channel_hotel_id": "12837615"
}{
"Status": "Success",
"Data": {
"host_location": "onsite",
"name_or_company": "test-use-demo",
"renting_date": "2024-10-11",
"renovating_date": "2024-10-12",
"built_date": "2024-10-09",
"is_company_profile": 1
},
"Message": "Property Profile Details Fetched Successfully",
"Ruid": "91e769ab-592a-48d5-9820-9233d9ef75b8"
}{
"Errors": [
{
"Code": "400",
"ShortText": "HotelCode: Invalid HotelCode ('NT711')"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Errors": [
{
"Code": "573",
"ShortText": "channel-mapping not found for this property!"
}
],
"Status": "Fail",
"Ruid": ""
}jpg, png, jpeg and gif image is allowed.
Only 1 image is allowed.
app-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key for authorization.
Content-Type
string
Yes
Must be set to application/json.
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/profile/setProfile-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json{
"hotel_id": "NT7",
"channel_hotel_id": "12837615",
"host_location": "onsite",
"name_or_company": "test-use-demo",
"renting_date": "2024-10-11",
"renovating_date": "2024-10-12",
"built_date": "2024-10-09",
"is_company_profile": 1,
"Images":[
{
"url": "https://www.xxxxxxx.com/xxxx/roadblue/xxxx.jpg"
}
]
}{
"Status": "Success",
"Data": [],
"Message": "Property Profile Set Successfully",
"Ruid": "xxxxxxxxx"
}{
"Errors": [
{
"Code": "400",
"ShortText": "HotelCode: Invalid HotelCode ('NT711')"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Errors": [
{
"Code": "573",
"ShortText": "channel-mapping not found for this property!"
}
],
"Status": "Fail",
"Ruid": ""
}{
"Status": "Fail",
"Errors": [],
"Message": "Field must contain a valid date in YYYY-MM-DD format. - [\"renting_date\"]",
"Ruid": "xxxxxxxxx"
}