# Create customer(s)

Creates one or more customers in the specified company.  
Supports bulk creation.  

Notes:  
- Create/Update APIs are in beta and may still evolve.

Endpoint: POST /customers
Security: BearerAuth

## Request fields (application/json):

  - `companyId` (string, required)
    Example: "98392"

  - `customers` (array, required)
    Example: [{"customerType":"Regular","firstName":"John","lastName":"Doe","displayName":"John Doe","companyName":"Doe Enterprises","phones":[{"number":"123-456-7890","label":"Work","type":"mobile","primary":true,"active":true}],"emails":[{"emailAddress":"john.doe@example.com","label":"Personal","primary":true,"active":true}],"communicationPreference":"email","notes":"VIP customer","mainAddress":{"address":"123 Main St","city":"New York","state":"NY","zip":"10001","country":"USA"},"taxExempt":false,"tags":[{"name":"VIP","color":"FFFF00"}],"chargeAccount":true,"preferredLocationID":"LOC123","languagePreference":"EN","okForMarketing":true}]

  - `customers.customerType` (string)
    Enum: "regular", "fleet"

  - `customers.firstName` (string, required)

  - `customers.lastName` (string, required)

  - `customers.displayName` (string)
    Search by customer name, email or phone

  - `customers.companyName` (string)

  - `customers.phones` (array)
    Example: [{"number":"123-456-7890","label":"Work","type":"mobile","primary":true,"active":true}]

  - `customers.phones.number` (string)
    Example: "123-456-7890"

  - `customers.phones.label` (string)
    Example: "Work"

  - `customers.phones.type` (string)
    Enum: "mobile", "landline"

  - `customers.phones.primary` (boolean)
    Example: true

  - `customers.phones.active` (boolean)
    Example: true

  - `customers.emails` (array)
    Example: [{"emailAddress":"john.doe@example.com","label":"Personal","primary":true,"active":true}]

  - `customers.emails.emailAddress` (string)
    Example: "john.doe@example.com"

  - `customers.communicationPreference` (string)
    Enum: "mobile", "email"

  - `customers.notes` (string)

  - `customers.mainAddress` (object)
    Example: {"address":"123 Main St","city":"New York","state":"NY","zip":"10001","country":"USA"}

  - `customers.mainAddress.address` (string)
    Example: "123 Main St"

  - `customers.mainAddress.zip` (string)
    Example: "10001"

  - `customers.mainAddress.city` (string)
    Example: "New York"

  - `customers.mainAddress.state` (string)
    Example: "NY"

  - `customers.mainAddress.country` (string)
    Example: "USA"

  - `customers.secondaryAddress` (object)
    Example: {"address":"123 Main St","city":"New York","state":"NY","zip":"10001","country":"USA"}

  - `customers.taxExempt` (boolean)

  - `customers.reasonForTaxExempt` (string)
    Enum: "Agricultural production", "Charitable organization", "..."

  - `customers.tags` (array)
    Example: [{"name":"VIP","color":"FFFF00"}]

  - `customers.tags.name` (string)
    Example: "VIP"

  - `customers.tags.color` (string)
    Example: "FFFF00"

  - `customers.chargeAccount` (boolean)

  - `customers.chargeAccountDetails` (object)

  - `customers.chargeAccountDetails.allowedLimit` (number)

  - `customers.chargeAccountDetails.usedLimit` (number)

  - `customers.chargeAccountDetails.unlimited` (boolean)

  - `customers.preferredLocationID` (string)

  - `customers.languagePreference` (string)
    Enum: "EN", "FR"

  - `customers.okForMarketing` (boolean)

## Response 200 fields (application/json):

  - `type` (string)
    Example: "Success"

  - `message` (string)
    Example: "Customer creation processed"

  - `results` (object)

  - `results.success` (array)

  - `results.success.status` (string)
    Example: "Created"

  - `results.success.data` (object)

  - `results.success.data.customerId` (string)
    Example: "120538"

  - `results.success.data.customerStatus` (string)
    Example: "Active"

  - `results.success.data.companyId` (string)
    Example: "98392"

  - `results.success.data.customerType` (string)
    Example: "Regular"

  - `results.success.data.firstName` (string)
    Example: "John"

  - `results.success.data.lastName` (string)
    Example: "Doe"

  - `results.success.data.companyName` (string)
    Example: "Doe Enterprises"

  - `results.success.data.phones` (array)

  - `results.success.data.phones.contactType` (string)
    Example: "mobile"

  - `results.success.data.phones.label` (string)
    Example: "mobile"

  - `results.success.data.phones.value` (string)
    Example: "123-456-7890"

  - `results.success.data.phones.isActive` (boolean)
    Example: true

  - `results.success.data.phones.isPrimary` (boolean)
    Example: true

  - `results.success.data.phones.isMarketingNotifEnabled` (boolean)

  - `results.success.data.emails` (array)

  - `results.success.data.communicationPreference` (string)
    Example: "email"

  - `results.success.data.notes` (string)
    Example: "VIP customer"

  - `results.success.data.mainAddress` (object)

  - `results.success.data.mainAddress.addLine1` (string)
    Example: "123 Main St"

  - `results.success.data.mainAddress.addLine2` (string)

  - `results.success.data.mainAddress.city` (string)
    Example: "New York"

  - `results.success.data.mainAddress.state` (string)
    Example: "NY"

  - `results.success.data.mainAddress.zip` (string)
    Example: 10001

  - `results.success.data.mainAddress.country` (string)
    Example: "USA"

  - `results.success.data.taxExempt` (boolean)

  - `results.success.data.reasonForTaxExempt` (string)

  - `results.success.data.tags` (array)

  - `results.success.data.tags.name` (string)
    Example: "VIP"

  - `results.success.data.tags.color` (string)
    Example: "#FFFF00"

  - `results.success.data.preferredLocation` (string)
    Example: "LOC123"

  - `results.success.data.languagePreference` (string)
    Example: "EN"

  - `results.success.data.createdDate` (string)
    Example: "2025-10-01T19:32:28.916Z"

  - `results.success.data.updatedDate` (string)
    Example: "2025-10-01T19:32:28.916Z"

  - `results.failed` (array)
    Example: []