---
title: "Create Customer"
method: POST
path: "/consumer/v1/customers"
tags: ["Customers"]
---

# Create Customer

`POST /consumer/v1/customers`

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.

## Request body

- CustomerInputModel
  - `locationId` string, nullable
  - `email` string, nullable
  - `name` string, nullable
  - `lastname` string, nullable
  - `firstname` string, nullable
  - `type` integer, nullable
  - `stripeCustomerId` string, nullable
  - `notificationType` string, nullable — 0 = default(Email), 1 = Email, 2 = SMS, 3 = Email and SMS
  - `sendLeadNotification` boolean
  - `address` AddressInputModel
    - `addressLine1` string, nullable
    - `addressLine2` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `country` string, nullable
    - `postalCode` string, nullable
  - `contact` ContactInputModel
    - `preferredPhoneType` string, nullable
    - `homePhone` string, nullable
    - `mobilePhone` string, nullable
    - `businessPhone` string, nullable
    - `businessPhoneExt` string, nullable
    - `skypeUsername` string, nullable
    - `conferenceInfo` string, nullable
  - `customFields` CustomFieldInputModel
    - `field1` string, nullable
    - `field2` string, nullable
    - `field3` string, nullable
    - `field4` string, nullable
    - `field5` string, nullable
    - `field6` string, nullable
    - `field7` string, nullable
    - `field8` string, nullable
    - `field9` string, nullable
    - `field10` string, nullable

## Response `200`

Success

- CustomerViewModel
  - `object` string, nullable
  - `id` string, nullable
  - `locationId` string, nullable
  - `businessName` string, nullable
  - `email` string, nullable
  - `name` string, nullable
  - `lastname` string, nullable
  - `firstname` string, nullable
  - `companyName` string, nullable
  - `gender` string, nullable
  - `birthdate` string, nullable
  - `lastVisitDate` string, nullable
  - `groupId` string, nullable
  - `resourceId` string, nullable
  - `createdOn` string, nullable
  - `createdBy` string, nullable
  - `registeredBy` string, nullable
  - `verifiedBy` string, nullable
  - `modifiedBy` string, nullable
  - `modifiedOn` string, nullable
  - `verificationDate` string, nullable
  - `registrationDate` string, nullable
  - `emailInfo` boolean, nullable
  - `emailPromotion` boolean, nullable
  - `disabled` boolean, nullable
  - `inviteEmailSent` string, nullable
  - `welcomeEmailSent` string, nullable
  - `deletedStatus` boolean
  - `deletedTime` string, nullable
  - `notificationType` string, nullable
  - `subscriptionId` string, nullable
  - `latitude` string, nullable
  - `longitude` string, nullable
  - `stripeCustomerId` string, nullable
  - `contact` ContactViewModel
    - `phoneType` string, nullable
    - `homePhone` string, nullable
    - `mobilePhone` string, nullable
    - `businessPhone` string, nullable
    - `businessPhoneExt` string, nullable
    - `skypeUsername` string, nullable
    - `conferenceInfo` string, nullable
  - `address` AddressViewModel
    - `addressLine1` string, nullable
    - `addressLine2` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `country` string, nullable
    - `postalCode` string, nullable
  - `customFields` object, nullable

---

[API](https://skmtc.net/onsched/apis/onsched-consumer-api.md) · [All operations](https://skmtc.net/onsched/apis/onsched-consumer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onsched/onsched-consumer-api/versions/1cd2a28a0305/schema)