action onsched_post_consumer_v1_customers { label: "Create Customer" description: "

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.

\n

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.

" provider: onsched method: POST path: "/consumer/v1/customers" encoding: json input: { type: "object" properties: { address: { type: "object" properties: { addressLine1: { type: "string" } addressLine2: { type: "string" } city: { type: "string" } country: { type: "string" } postalCode: { type: "string" } state: { type: "string" } } additionalProperties: false } contact: { type: "object" properties: { businessPhone: { type: "string" } businessPhoneExt: { type: "string" } conferenceInfo: { type: "string" } homePhone: { type: "string" } mobilePhone: { type: "string" } preferredPhoneType: { type: "string" } skypeUsername: { type: "string" } } additionalProperties: false } customFields: { type: "object" properties: { field1: { type: "string" } field10: { type: "string" } field2: { type: "string" } field3: { type: "string" } field4: { type: "string" } field5: { type: "string" } field6: { type: "string" } field7: { type: "string" } field8: { type: "string" } field9: { type: "string" } } additionalProperties: false } email: { type: "string" } firstname: { type: "string" } lastname: { type: "string" } locationId: { type: "string" } name: { type: "string" } notificationType: { type: "string" description: "0 = default(Email), 1 = Email, 2 = SMS, 3 = Email and SMS" } sendLeadNotification: { type: "boolean" } stripeCustomerId: { type: "string" } type: { type: "integer" format: "int32" } } additionalProperties: false } output: { type: "object" properties: { address: { type: "object" properties: { addressLine1: { type: "string" } addressLine2: { type: "string" } city: { type: "string" } country: { type: "string" } postalCode: { type: "string" } state: { type: "string" } } additionalProperties: false } birthdate: { type: "string" } businessName: { type: "string" } companyName: { type: "string" } contact: { type: "object" properties: { businessPhone: { type: "string" } businessPhoneExt: { type: "string" } conferenceInfo: { type: "string" } homePhone: { type: "string" } mobilePhone: { type: "string" } phoneType: { type: "string" } skypeUsername: { type: "string" } } additionalProperties: false } createdBy: { type: "string" } createdOn: { type: "string" } customFields: { type: "object" } deletedStatus: { type: "boolean" } deletedTime: { type: "string" } disabled: { type: "boolean" } email: { type: "string" } emailInfo: { type: "boolean" } emailPromotion: { type: "boolean" } firstname: { type: "string" } gender: { type: "string" } groupId: { type: "string" } id: { type: "string" } inviteEmailSent: { type: "string" } lastVisitDate: { type: "string" } lastname: { type: "string" } latitude: { type: "string" } locationId: { type: "string" } longitude: { type: "string" } modifiedBy: { type: "string" } modifiedOn: { type: "string" } name: { type: "string" } notificationType: { type: "string" } object: { type: "string" } registeredBy: { type: "string" } registrationDate: { type: "string" } resourceId: { type: "string" } stripeCustomerId: { type: "string" } subscriptionId: { type: "string" } verificationDate: { type: "string" } verifiedBy: { type: "string" } welcomeEmailSent: { type: "string" } } additionalProperties: false } }