Set Contact
You can set multiple contacts with different contact types but with the same contact details.
Endpoint
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.
Attributes
hotel_id alphanumeric (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.
contacts object (Required)
An array of contact objects containing contact details.
contact_profiles object (Required)
A list of profiles associated with the contact (e.g., invoices, general).
type enumerated string (Required)
Specify the contact type.
address object
NOTE
The sub-attributes of the "address" object are required only when the "address" key is specified in the request. If the "address" key is omitted, these sub-attributes should not be included.
Contains the address details of the contact including country, city and postal code details.
city_name string (Required if address is specified)
The city name where the contact is located.
country_codeenumerated string (Required)
The ISO country code of the contact's location.
postal_code string (Required)
The postal code of the contact's location.
address_line string (Required)
The street address of the contact.
language_code enumerated string (Required)
The language code for the address.
contact_person object
Details about the contact person.
gender enumerated string (Optional)
Gender of the contact person.
name string (Required)
Full name of the contact person.
job_title enumerated string (Optional)
Job title of the contact person.
language_code string (Required)
Language code for the contact person (e.g., 'en-gb').
phones array (Required)
List of phone numbers associated with the contact.
phone_number string (Required)
The actual phone number (all international phone numbers).
phone_tech_type enumerated string (Required)
Technology type of the phone (for example, '1' for landline).
extension string (Optional)
Extension number for the phone, if applicable.
email string (Required)
Email address of the contact.
Sample Request
Response
Sample Success Response
Error
Sample Error Response 1
Sample Error Response 2
Sample Error Response 3
Sample Error Response 4
Response Body Elements
Status string
The status of the response.
Data object
The response data, the root element.
property_id string
Specifies the property ID that was created.
Message string
The message in the 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
Brief description of the error.
Last updated
Was this helpful?