Contacts endpoint (1.0)

Contains Contacts endpoint specification.

Overview
License
Languages
Servers
https://developers.booking.com/

Contacts

Operations

Read all Contact(s) for a Property

Request

Path
propertyIdinteger(int32)required

The Property ID of which you wish to retrieve the data

Headers
Accept-Versionstring
curl -i -X GET \
  'https://developers.booking.com/properties/{propertyId}/contacts' \
  -H 'Accept-Version: string'

Responses

successful operation

Bodyapplication/json
dataobject(ContactInfo)

List of all contacts

warningsArray of objects(ApiError)
errorsArray of objects(ApiError)
metaobject(ResponseMeta)
Response
application/json
{ "data": { "contacts": [] }, "warnings": [ {} ], "errors": [ {} ], "meta": { "ruid": "string" } }

Overlay multiple Contacts for a Property

Request

Contacts not sent will be reset/deleted.

Path
propertyIdinteger(int32)required

The Property ID of which you wish to update the data

Headers
Accept-Versionstring
Bodyapplication/json
contactsArray of objects(Contact)required

General contact type is mandatory for setting up the property. Validation: ContactProfileType entries cannot be repeated within the same array. General contact can have only 1 entry in total. Current Documentation: ContactInfo Root Object

contacts[].​contact_profilesArray of objects(ContactProfile)required

Type of Contact Profiles. Each value corresponds with a similarly named heading on the Contacts page. Validation: Must be one of provided values. Current Documentation DataMapping: ContactInfo/ContactProfileType

contacts[].​contact_profiles[].​typestringrequired

Type of Contact Profile. Each value corresponds with a similarly named heading on the Contacts page. Current Documentation DataMapping: ContactInfo/ContactProfileType

Enum"general""contract""reservations""invoices""availability""site_content""parity""requests""central_reservations"
contacts[].​addressobject(ContactAddress)
contacts[].​contact_personobject(ContactPerson)required
contacts[].​contact_person.​genderstringmale|female
Value"male, female"
contacts[].​contact_person.​namestringrequired
contacts[].​contact_person.​job_titlestring
contacts[].​contact_person.​language_codestringrequired
contacts[].​phonesArray of objects(ContactPhone)required

Validation: Cannot be null/empty PhoneTechType 1 can have at most 3 entries. PhoneTechType 3 and 5 can have at most 1 entry. Extension can only be provided for PhoneTechType 1 DataMapping: ContactInfo/Phones

contacts[].​phones[].​phone_numberstringrequired

The international phone number. Validation: We validate for country specific formats for the number against the address provided. Current Documentation: PhoneNumber DataMapping: ContactInfo/Phones/PhoneNumber

contacts[].​phones[].​phone_tech_typeinteger(int32)required
Valuenull
contacts[].​phones[].​extensionstring

The extension number that must be dialled in addition to the @PhoneNumber. Validation: Only accepted when @PhoneTechType= "1". Current Documentation: Extension DataMapping: ContactInfo/Phones/Extension

contacts[].​emailstringrequired

Email address for a contact person/point. Validation: Email must be of a standard format. Current Documentation DataMapping: ContactInfo/Emails/Email

curl -i -X PUT \
  'https://developers.booking.com/properties/{propertyId}/contacts' \
  -H 'Accept-Version: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "contacts": [
      {
        "contact_profiles": [
          {
            "type": "general"
          }
        ],
        "address": {
          "city_name": "string",
          "country_code": "string",
          "postal_code": "string",
          "address_line": "string",
          "language_code": "string"
        },
        "contact_person": {
          "gender": "male, female",
          "name": "string",
          "job_title": "string",
          "language_code": "string"
        },
        "phones": [
          {
            "phone_number": "string",
            "phone_tech_type": null,
            "extension": "string"
          }
        ],
        "email": "string"
      }
    ]
  }'

Responses

successful operation

Bodyapplication/json
dataobject
warningsArray of objects(ApiError)
errorsArray of objects(ApiError)
metaobject(ResponseMeta)
Response
application/json
{ "data": {}, "warnings": [ {} ], "errors": [ {} ], "meta": { "ruid": "string" } }