When creating a customer, if the email/phoneNumber pair already exists, no new record is created. Only previously empty (null) data is then filled in; the other fields remain unchanged.
Header parameters
X-API-KEYstringRequired
Partner API Key
X-API-SECRETstringRequired
Partner API Secret
Body
descriptionstring | nullableOptional
Description of the customer
companystring | nullableOptional
Company name of the customer
firstNamestring | nullableOptional
First name of the customer
lastNamestring | nullableOptional
Last name of the customer
displayNamestring | nullableOptional
Display name of the customer
Usually a concatenation of first name and last name
phoneNumberstring | nullableOptional
Phone number of the customer
emailstring · email | nullableOptional
Email address of the customer
civilitystring | nullableOptional
Civility of the customer (e.g., Mr., Ms., etc.)
languageall of | nullableOptional
Language preference of the customer
string · enumOptionalPossible values:
metadataobjectOptional
Additional metadata to store with the customer
This is a key-value pair object where both keys and values are strings
smsOptinboolean | nullableOptional
SMS opt-in status of the customer
emailOptinboolean | nullableOptional
Email opt-in status of the customer
zenchefIdstring | nullableOptional
ID of the customer in Zenchef system
ubereatsIdstring | nullableOptional
ID of the customer in UberEats system
deliverooIdstring | nullableOptional
ID of the customer in Deliveroo system
zeltyIdstring | nullableOptional
ID of the customer in Zelty system
sevenroomsIdstring | nullableOptional
ID of the customer in Sevenrooms system
metaIdstring | nullableOptional
ID of the customer in Meta system (Facebook/Instagram)
mewsIdstring | nullableOptional
ID of the customer in Mews system
oracleIdstring | nullableOptional
ID of the customer in Oracle system
partoucheIdstring | nullableOptional
ID of the customer in Partouche system
comoIdstring | nullableOptional
ID of the customer in Como system
theForkIdstring | nullableOptional
ID of the customer in TheFork system
chr365Idstring | nullableOptional
ID of the customer in Chr365 system
Responses
201
The customer has been successfully imported.
application/json
400
Invalid input format.
401
Unauthorized
post
/partners/customer
List customers
post
Header parameters
X-API-KEYstringRequired
Partner API Key
X-API-SECRETstringRequired
Partner API Secret
Body
limitnumber · min: 1 · max: 100Optional
Pagination limit
Default: 10
pagenumber · min: 1Optional
Page to retrieve
Default: 1
Responses
201
The customers have been successfully listed.
application/json
400
Invalid input format.
401
Unauthorized
post
/partners/customer/list
Import a batch of customer
post
When creating a customer, if the email/phoneNumber pair already exists, no new record is created. Only previously empty (null) data is then filled in; the other fields remain unchanged.