v1

latestOpenAPI 3.0.12026-07-133870165.8 KB
Customers

Create Customer

Use this endpoint to Create a new Customer. A customer object is automatically created with the first appointment booking if it doesn't already exist. If not specified, the business location id defaults to the primary business location.

Required Fields: Email and Name or First and Lastname depending on customer type. Type 0 = Person, Type 1 = Business. For type 0, the firstname and lastname fields are used. For type 1, the Name field is used, and the name field is also used to populate the lastname.

post/consumer/v1/customers

Request body

locationIdstring nullable
emailstring nullable
namestring nullable
lastnamestring nullable
firstnamestring nullable
typeinteger nullable
stripeCustomerIdstring nullable
notificationTypestring nullable

0 = default(Email), 1 = Email, 2 = SMS, 3 = Email and SMS

sendLeadNotificationboolean

Response

Success

objectstring nullable
idstring nullable
locationIdstring nullable
businessNamestring nullable
emailstring nullable
namestring nullable
lastnamestring nullable
firstnamestring nullable
companyNamestring nullable
genderstring nullable
birthdatestring nullable
lastVisitDatestring nullable
groupIdstring nullable
resourceIdstring nullable
createdOnstring nullable
createdBystring nullable
registeredBystring nullable
verifiedBystring nullable
modifiedBystring nullable
modifiedOnstring nullable
verificationDatestring nullable
registrationDatestring nullable
emailInfoboolean nullable
emailPromotionboolean nullable
disabledboolean nullable
inviteEmailSentstring nullable
welcomeEmailSentstring nullable
deletedStatusboolean
deletedTimestring nullable
notificationTypestring nullable
subscriptionIdstring nullable
latitudestring nullable
longitudestring nullable
stripeCustomerIdstring nullable
customFieldsobject nullable