v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Customers

Add customer

Adds a new customer to the system and returns details of the added customer. If a customer with the specified email already exists, and OverwriteExisting is set to true, then the existing customer profile information is overwritten and the existing customer data returned. If OverwriteExisting is set to false, an error response is returned. Note this operation supports Portfolio Access Tokens.

post/api/connector/v1/customers/add

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

Title'Mister' | 'Miss' | 'Misses'

Type of the title prefix of the customer.

Note that the value should not be used as-is, but localized. For example, the value Misses should be displayed as Mrs. in English and Fr. in German.

Mister (Mr.)

Miss (Ms.)

Misses (Mrs.)

FirstNamestring nullable

First name of the customer.

LastNamestring required

Last name of the customer.

SecondLastNamestring nullable

Second last name of the customer.

NationalityCodestring nullable

ISO 3166-1 code of the Country.

PreferredLanguageCodestring nullable

Language and culture code of the customer's preferred language, according to their profile. For example: en-GB, fr-CA.

Sex'Male' | 'Female'
BirthDatestring date nullable

Date of birth in ISO 8601 format.

BirthCountryCodestring nullable

Country of birth.

BirthCountrySubdivisionCodestring nullable

Province of birth.

BirthPlacestring nullable

Place of birth.

Occupationstring nullable

Occupation of the customer.

Emailstring email nullable

Email address of the customer.

Phonestring tel nullable

Phone number of the customer (possibly mobile).

LoyaltyCodestring nullable

Loyalty code of the customer.

Notesstring nullable

Internal notes about the customer.

CarRegistrationNumberstring nullable

Registration number of the customer's car.

DietaryRequirementsstring nullable

Customer's dietary requirements, e.g. Vegan, Halal.

TaxIdentificationNumberstring nullable

Tax identification number of the customer.

CompanyIdstring uuid nullable

Unique identifier of Company the customer is associated with.

ClassificationsCustomerClassificationEnum[] nullable

Classifications of the customer.

OptionsCustomerOptionEnum[] nullable

Options of the customer.

ChainIdstring uuid nullable

Unique identifier of the chain. Required when using PortfolioAccessTokens, ignored otherwise.

OverwriteExistingboolean required

Whether an existing customer should be overwritten in case of duplicity. This applies only to basic personal information (Title, FirstName, LastName, ...).

ItalianDestinationCodestring nullable

Value of Italian destination code.

ItalianFiscalCodestring nullable

Value of Italian fiscal code.

ItalianLotteryCodestring nullable

Value of Italian lottery code.

Response

OK

Idstring uuid required

Unique identifier of the customer.

ChainIdstring uuid required

Unique identifier of the chain.

Numberstring required

Unique number of the customer (max 19 digits).

Title'Mister' | 'Miss' | 'Misses'

Type of the title prefix of the customer.

Note that the value should not be used as-is, but localized. For example, the value Misses should be displayed as Mrs. in English and Fr. in German.

Mister (Mr.)

Miss (Ms.)

Misses (Mrs.)

Sex'Male' | 'Female'

Male

Female

FirstNamestring nullable

First name of the customer.

LastNamestring required

Last name of the customer.

SecondLastNamestring nullable

Second last name of the customer.

NationalityCodestring nullable

ISO 3166-1 code of the Country.

PreferredLanguageCodestring nullable

Language and culture code of the customer's preferred language, according to their profile. For example: en-GB, fr-CA.

LanguageCodestring nullable

Language and culture code of the customer's language, based on multiple sources. These sources include the preferred language specified in internal data based on previous bookings, and the preferred language of the customer specified in their profile. If neither of these sources are present, we use the native language based on the customer's nationality. The format is, for example, en-US or fr-FR.

BirthDatestring nullable

Date of birth in ISO 8601 format.

BirthCountryCodestring nullable

ISO 3166-1 alpha-2 code of the birth country.

BirthCountrySubdivisionCodestring nullable

ISO 3166-2 code of the administrative division, e.g. ES-C.

BirthPlacestring nullable

Place of birth.

Occupationstring nullable

Occupation of the customer.

Emailstring nullable

Email address of the customer.

HasOtaEmailboolean

Whether the customer's email address is a temporary email address from an OTA. For more details, see the product documentation.

Phonestring nullable

Phone number of the customer (possibly mobile).

TaxIdentificationNumberstring nullable

Tax identification number of the customer.

LoyaltyCodestring nullable

Loyalty code of the customer.

AccountingCodestring nullable

Accounting code of the customer.

BillingCodestring nullable

Billing code of the customer.

Notesstring nullable

Internal notes about the customer.

CarRegistrationNumberstring nullable

Registration number of the customer's car.

DietaryRequirementsstring nullable

Customer's dietary requirements, e.g. Vegan, Halal.

CreatedUtcstring date-time required

Creation date and time of the customer in UTC timezone in ISO 8601 format.

UpdatedUtcstring date-time required

Last update date and time of the customer in UTC timezone in ISO 8601 format.

AddressIdstring uuid nullable

Unique identifier of the Address of the customer.

ClassificationsCustomerClassificationEnum[] required

Classifications of the customer.

OptionsCustomerOptionsEnum[] required

Options of the customer.

ItalianDestinationCodestring nullable

Value of Italian destination code.

ItalianFiscalCodestring nullable

Value of Italian fiscal code.

ItalianLotteryCodestring nullable

Italian lottery code.

CompanyIdstring uuid nullable

Unique identifier of Company the customer is associated with.

MergeTargetIdstring uuid nullable

Unique identifier of the account (Customer) to which this customer is linked.

ActivityStatestring nullable

Activity State of customer record, i.e. whether active or deleted.

IsActiveboolean required

Whether the customer record is still active.

PreferredSpaceFeaturesResourceFeatureClassification[] required

A list of room preferences, such as view type, bed type, and amenities.

CreatorProfileIdstring uuid required

Unique identifier of the user who created the customer.

UpdaterProfileIdstring uuid required

Unique identifier of the user who last updated the customer.