Set CheckIn Methods
This endpoint allows users to set or update the check-in methods for a specific hotel, enabling customized instructions and contact methods for guests upon arrival.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/property/keycollection/setCheckInMethodsHeader
-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/jsonapp-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.
checkin_methods array (Required)
An array of objects defining the check-in methods. Each object includes:
checkin_method string (Required)
The method of check-in.
additional_info object (Optional)
Additional details about the check-in method. This includes:
brand_name string (Optional)
The brand associated with the check-in method.
instruction object (Optional)
Instructions on how to check in, including:
how string (Required)
The mode of contact.
identifier string (Required)
A contact number or identifier for the method.
other string (Required if how key contains 'other' value)
Specifies the alternative method
when string (Optional)
Indicates when to use the contact method.
location object (Optional)
Details about the check-in location, including:
off_location integer (Required if location key passed; value must be 0 or 1)
Indicates if the location is off-site (1 for true, 0 for false).
address string (Required if location key passed)
The specific address for check-in. Example: "Street name, number 12".
city string (Required if location key passed)
The city where the check-in is located, e.g., "Amsterdam".
place_id string (Optional)
The Google Place ID for the location.
zip string (Optional)
The postal code for the location.
other_text object (Optional)
Additional information in text form, including:
lang string (Optional)
Language code for the text.
text string (Optional)
The content of the additional information.
external_references array (Optional)
References to external resources such as images, including:
references object (Required)
Contains a reference to an external resource.
photo_id integer (Required)
sequence integer (Required if external_references key passed)
The order of the reference in the list.
type string (Required if external_references key passed; value must be 'image_service')
Type of the reference, must be "image_service".
stream_variation_name string (Required)
The name of the primary check-in method, e.g., "primary_checkin_method".
Sample Request
{
"hotel_id": "new1",
"channel_hotel_id": "12915674",
"checkin_methods": [
{
"checkin_method": "instruction_contact_us",
"additional_info": {
"brand_name": "Samsung",
"instruction": {
"how": "other",
"identifier": "+31612345678",
"other": "whatsapp",
"when": "immediate"
},
"location": {
"off_location": 1,
"address": "Street name, number 12",
"city": "Amsterdam",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"zip": "1017 CE"
},
"other_text": {
"lang": "en-gb",
"text": "We have 24-hour reception at our property"
}
},
"external_references": [
{
"references": {
"photo_id": 12345678
},
"sequence": 1,
"type": "image_service"
},
{
"references": {
"photo_id": 2345678
},
"sequence": 2,
"type": "image_service"
}
],
"stream_variation_name": "primary_checkin_method"
}
]
}Response
Sample Success Response
{
"Status": "Success",
"Data": [],
"Message": "Property Check-In Method Set Successfully",
"Ruid": "UmFuZG9tSVYkc2RlIyh9YR8UCyEd6Sj0sl9DXShM5Is9yNe+/8dlfbuXeDlWufI3oeuxPQ8liW25qyHgupIuQVV2KQLeF3qPsyzbBRFcgqQ="
}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.
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.
ShortText string
A short description of the error.
Message string
A message providing more information about the error.
Last updated
Was this helpful?