Set Hotelier Message

This endpoint allows you to configure and update messages from the hotelier associated with a specific property.


Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/profile/setHotelierMessage
-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json
Header
Type
Required
Description

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.


Attributes

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.

Example: "en-nz" for English (New Zealand).

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.


Sample Request

{
   "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"
   }
}

Response

Sample Success Response

{
   "Status": "Success",
   "Data": [],
   "Message": "Hotelier Message Set Successfully",
   "Ruid": "5cf60f13-bccf-4a11-a277-5b3510052014"
}

Success Response Body Elements

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.

UUID format


Errors

Sample Error Response 1

{
   "Errors": [
       {
           "Code": "400",
           "ShortText": "HotelCode: Invalid HotelCode ('NT711')"
       }
   ],
   "Status": "Fail",
  "Ruid": ""
}

Sample Error Response 2

{
   "Errors": [
       {
           "Code": "573",
           "ShortText": "channel-mapping not found for this property!"
       }
   ],
   "Status": "Fail",
  "Ruid": ""
}

Sample Error Response 3

{
   "Status": "Fail",
   "Errors": [],
   "Message": "Access denied",
  "Ruid": "xxxxxx"
}

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.

For example: "400" indicates a bad request.

ShortText string

A short description of the error.


Message string

A message providing more information about the error.

Last updated

Was this helpful?