Customer
Bearer token using a JWT
The microsite name.
OK
Contains basic information about a restaurant.
OK
Bearer token using a JWT
The provider's microsite name.
The customer Id.
OK
The customer object is used to store the details of the person who made a particular booking. Each customer is identified by an Id, which is unique to the restaurant group that they were created in. This means that customers are shared between all restaurants in the same group.
The customer has a number of custom fields associated with it. Please note that you will not be able to set these when creating a customer unless the associated custom field has been configured in the restaurant.
The customer's Id - unique within a restaurant group.
The customer's title.
The customer's first name.
The customer's surname (last name).
The customer's company.
The customer's department.
The customer's email address.
The customer's mobile number country code.
The customer's mobile number.
The customer's phone number country code.
The customer's phone number.
true if the customer is a VIP, false otherwise.
true if the customer wishes to receive email marketing, false otherwise.
true if the customer wishes to receive SMS marketing, false otherwise.
Any comments about the customer.
The customer's birthday.
The customer's anniversary.
true if the customer is of the legal drinking age, false otherwise.
The customer's membership id.
The customer's first custom field.
The customer's second custom field.
The customer's third custom field.
The customer's fourth custom field.
The customer's fifth custom field.
true if the customer is blocked (i.e. not allowed to make bookings), false otherwise.
An array of the customer code Ids for the customer.
The date and time that the customer was created.
The email marketing opt in text for the group.
The sms marketing opt in text for the group.
True if the customer wishes to receive restaurant email marketing, false otherwise.
True if the customer wishes to receive restaurant sms marketing, false otherwise.
The email marketing opt in text for the restaurant.
The sms marketing opt in text for the restaurant.
The portal user Id of the customer.
If the property is supplied and set as true then the api request/customer has declined to include an email address.
The customer's rank
OK
Bearer token using a JWT
The provider's microsite name.
The Id of the customer.
A request used to create a restaurant customer.
The customer's title.
The customer's first name.
The customer's surname (last name).
The customer's company.
The customer's department.
The customer's email address.
The customer's phone number country code.
The customer's phone number.
The customer's mobile (cell) phone number country code.
The customer's mobile (cell) phone number.
true if the customer is a VIP, false otherwise.
true if the customer wishes to receive email marketing, false otherwise.
true if the customer wishes to receive SMS marketing, false otherwise.
Any comments about the customer.
The customer's birthday.
The customer's anniversary.
true if the customer is of the legal drinking age, false otherwise.
The customer's membership id.
The customer's first custom field.
The customer's second custom field.
The customer's third custom field.
The customer's fourth custom field.
The customer's fifth custom field.
An array of the customer code Ids for the customer.
The IP address where this customer is being created from
Which Marketing Opt-in setting to use
The email marketing opt in text for the group.
The sms marketing opt in text for the group.
True if the customer wishes to receive restaurant email marketing, false otherwise.
True if the customer wishes to receive restaurant sms marketing, false otherwise.
The email marketing opt in text for the restaurant.
The sms marketing opt in text for the restaurant.
Which Customer Validation Type to use when creating or updating a customer, Defaults to Normal
The customer type.
OK
The customer object is used to store the details of the person who made a particular booking. Each customer is identified by an Id, which is unique to the restaurant group that they were created in. This means that customers are shared between all restaurants in the same group.
The customer has a number of custom fields associated with it. Please note that you will not be able to set these when creating a customer unless the associated custom field has been configured in the restaurant.
The customer's Id - unique within a restaurant group.
The customer's title.
The customer's first name.
The customer's surname (last name).
The customer's company.
The customer's department.
The customer's email address.
The customer's mobile number country code.
The customer's mobile number.
The customer's phone number country code.
The customer's phone number.
true if the customer is a VIP, false otherwise.
true if the customer wishes to receive email marketing, false otherwise.
true if the customer wishes to receive SMS marketing, false otherwise.
Any comments about the customer.
The customer's birthday.
The customer's anniversary.
true if the customer is of the legal drinking age, false otherwise.
The customer's membership id.
The customer's first custom field.
The customer's second custom field.
The customer's third custom field.
The customer's fourth custom field.
The customer's fifth custom field.
true if the customer is blocked (i.e. not allowed to make bookings), false otherwise.
An array of the customer code Ids for the customer.
The date and time that the customer was created.
The email marketing opt in text for the group.
The sms marketing opt in text for the group.
True if the customer wishes to receive restaurant email marketing, false otherwise.
True if the customer wishes to receive restaurant sms marketing, false otherwise.
The email marketing opt in text for the restaurant.
The sms marketing opt in text for the restaurant.
The portal user Id of the customer.
If the property is supplied and set as true then the api request/customer has declined to include an email address.
The customer's rank
OK
Bearer token using a JWT
The provider's microsite name.
A request to merge customers
The id of the master customer that other customers are to be merged into.
The ids of the customers that are to be merged in to the master customer (maximum of 10).
OK
The customer object is used to store the details of the person who made a particular booking. Each customer is identified by an Id, which is unique to the restaurant group that they were created in. This means that customers are shared between all restaurants in the same group.
The customer has a number of custom fields associated with it. Please note that you will not be able to set these when creating a customer unless the associated custom field has been configured in the restaurant.
The customer's Id - unique within a restaurant group.
The customer's title.
The customer's first name.
The customer's surname (last name).
The customer's company.
The customer's department.
The customer's email address.
The customer's mobile number country code.
The customer's mobile number.
The customer's phone number country code.
The customer's phone number.
true if the customer is a VIP, false otherwise.
true if the customer wishes to receive email marketing, false otherwise.
true if the customer wishes to receive SMS marketing, false otherwise.
Any comments about the customer.
The customer's birthday.
The customer's anniversary.
true if the customer is of the legal drinking age, false otherwise.
The customer's membership id.
The customer's first custom field.
The customer's second custom field.
The customer's third custom field.
The customer's fourth custom field.
The customer's fifth custom field.
true if the customer is blocked (i.e. not allowed to make bookings), false otherwise.
An array of the customer code Ids for the customer.
The date and time that the customer was created.
The email marketing opt in text for the group.
The sms marketing opt in text for the group.
True if the customer wishes to receive restaurant email marketing, false otherwise.
True if the customer wishes to receive restaurant sms marketing, false otherwise.
The email marketing opt in text for the restaurant.
The sms marketing opt in text for the restaurant.
The portal user Id of the customer.
If the property is supplied and set as true then the api request/customer has declined to include an email address.
The customer's rank
OK
Bearer token using a JWT
The provider's microsite name.
A request used to create a restaurant customer.
The customer's title.
The customer's first name.
The customer's surname (last name).
The customer's company.
The customer's department.
The customer's email address.
The customer's phone number country code.
The customer's phone number.
The customer's mobile (cell) phone number country code.
The customer's mobile (cell) phone number.
true if the customer is a VIP, false otherwise.
true if the customer wishes to receive email marketing, false otherwise.
true if the customer wishes to receive SMS marketing, false otherwise.
Any comments about the customer.
The customer's birthday.
The customer's anniversary.
true if the customer is of the legal drinking age, false otherwise.
The customer's membership id.
The customer's first custom field.
The customer's second custom field.
The customer's third custom field.
The customer's fourth custom field.
The customer's fifth custom field.
An array of the customer code Ids for the customer.
The IP address where this customer is being created from
Which Marketing Opt-in setting to use
The email marketing opt in text for the group.
The sms marketing opt in text for the group.
True if the customer wishes to receive restaurant email marketing, false otherwise.
True if the customer wishes to receive restaurant sms marketing, false otherwise.
The email marketing opt in text for the restaurant.
The sms marketing opt in text for the restaurant.
Which Customer Validation Type to use when creating or updating a customer, Defaults to Normal
The customer type.
OK
The customer object is used to store the details of the person who made a particular booking. Each customer is identified by an Id, which is unique to the restaurant group that they were created in. This means that customers are shared between all restaurants in the same group.
The customer has a number of custom fields associated with it. Please note that you will not be able to set these when creating a customer unless the associated custom field has been configured in the restaurant.
The customer's Id - unique within a restaurant group.
The customer's title.
The customer's first name.
The customer's surname (last name).
The customer's company.
The customer's department.
The customer's email address.
The customer's mobile number country code.
The customer's mobile number.
The customer's phone number country code.
The customer's phone number.
true if the customer is a VIP, false otherwise.
true if the customer wishes to receive email marketing, false otherwise.
true if the customer wishes to receive SMS marketing, false otherwise.
Any comments about the customer.
The customer's birthday.
The customer's anniversary.
true if the customer is of the legal drinking age, false otherwise.
The customer's membership id.
The customer's first custom field.
The customer's second custom field.
The customer's third custom field.
The customer's fourth custom field.
The customer's fifth custom field.
true if the customer is blocked (i.e. not allowed to make bookings), false otherwise.
An array of the customer code Ids for the customer.
The date and time that the customer was created.
The email marketing opt in text for the group.
The sms marketing opt in text for the group.
True if the customer wishes to receive restaurant email marketing, false otherwise.
True if the customer wishes to receive restaurant sms marketing, false otherwise.
The email marketing opt in text for the restaurant.
The sms marketing opt in text for the restaurant.
The portal user Id of the customer.
If the property is supplied and set as true then the api request/customer has declined to include an email address.
The customer's rank
OK
Unsubscribe customers from marketing
Bearer token using a JWT
The provider's microsite name.
Represents customers to be unsubscribed.
The customer Ids of the customers to be unsubscribed.
The IP address of the device unsubscribing the customers.
The marketing communication mode.
OK
OK
Schedule customers for deletion
Bearer token using a JWT
The provider's microsite name.
Represents customers to be deleted.
The customer Ids of the customers to be deleted.
OK
The response when marking customers as deleted.
The IDs of any customers that were successfully marked as deleted.
The IDs of any customers that were skipped.
OK
Last updated
Was this helpful?