Property Status Check
Last updated
Was this helpful?
Last updated
Was this helpful?
This endpoint is used to check the status of a property. The API will return information about the property's status, including any difficulties that prohibit it from being processed properly.
POST
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
.
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 (Required)
The status to check for the property.
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.
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.