Skip to main content
POST
/
customers
Create a new Customer
curl --request POST \
  --url https://commerce.driv.ly/api/customers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "customerId": "<string>",
  "leads": [
    123
  ],
  "address": 123,
  "shippingContact": 123,
  "deals": [
    123
  ],
  "createdBy": 123,
  "lastModifiedBy": 123,
  "email": "<string>",
  "phone": "<string>",
  "insurancePolicies": [
    123
  ],
  "tenants": [
    123
  ],
  "consumerStatus": "SOLD",
  "consumerFirstName": "<string>",
  "consumerMiddleName": "<string>",
  "consumerLastName": "<string>",
  "consumerSuffix": "<string>",
  "consumerDateOfBirth": "<string>",
  "consumerEducationLevel": "<string>",
  "consumerVehicles": [
    123
  ],
  "consumerPhoneType": "<string>",
  "consumerDriversLicense": "<string>",
  "consumerDriversLicenseState": "<string>",
  "consumerDriversLicenseNumber": "<string>",
  "consumerDriversLicenseExp": "<string>",
  "consumerDriversLicenseExpiration": "<string>",
  "consumerPreApprovals": [
    123
  ],
  "consumerGetPreApproved": "<string>",
  "consumerProvideProofOfInsurance": "<string>",
  "consumerLoginToBank": "<string>",
  "consumerConnectCar": "<string>",
  "consumerProvideProofOfIncome": "<string>",
  "consumerConsumerId": "<string>",
  "consumerCreditApplicationId": "<string>",
  "deals2": [
    123
  ],
  "consumerSocialSecurity": "<string>",
  "consumerDriversLicenceState": "<string>",
  "consumerIncome": 123,
  "consumerIncomeInterval": "<string>",
  "consumerEmploymentStatusCode": "<string>",
  "consumerEmploymentDuration": 123,
  "consumerEmployerName": "<string>",
  "consumerEmployerPhone": "<string>",
  "consumerEmploymentTitle": "<string>",
  "consumerPreviousEmployerName": "<string>",
  "consumerPreviousEmployerPhone": "<string>",
  "consumerPreviousEmploymentTitle": "<string>",
  "consumerPreviousEmploymentDuration": 123,
  "consumerPreviousEmploymentincome": 123,
  "consumerTimeAtResidence": 123,
  "consumerPreviousAddressLine1": "<string>",
  "consumerPreviousAddressLine2": "<string>",
  "consumerPreviousAddressCity": "<string>",
  "consumerPreviousAddressState": "<string>",
  "consumerPreviousZip": "<string>",
  "consumerPreviousAddressDuration": 123,
  "consumerResidenceType": "<string>",
  "consumerRentMortgage": 123,
  "consumerOtherIncomeDescription": "<string>",
  "consumerOtherIncomeAmount": 123,
  "consumerLeadSource": [
    "Car Concierge (Andrew)"
  ],
  "companyName": "<string>",
  "companyDealerDeals": [
    123
  ],
  "companyDealsFacilitated": [
    123
  ],
  "companyInsuranceQuotes": [
    123
  ],
  "companyType": [
    "Dealer"
  ],
  "companyWebsite": "<string>",
  "companyStripeConnectLink": "<string>",
  "companyCustomerPortalLink": "<string>",
  "companyServiceQuotes": [
    123
  ],
  "companyServiceOrders": "<string>",
  "companyServiceQuotesPartners": [
    123
  ],
  "companyVisibility": "<string>",
  "companyTenants2": [
    123
  ],
  "companyCustomer": [
    123
  ],
  "companyTrades": [
    123
  ],
  "companyTenants3": [
    123
  ],
  "companyPartnerBrand": 123,
  "companyDeals3": [
    123
  ],
  "companyRouteOneDealer": "<string>",
  "companyTransportServiceOrders": [
    123
  ]
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "customerId": "<string>",
    "leads": [
      123
    ],
    "address": 123,
    "shippingContact": 123,
    "deals": [
      123
    ],
    "createdBy": 123,
    "lastModifiedBy": 123,
    "email": "<string>",
    "phone": "<string>",
    "insurancePolicies": [
      123
    ],
    "tenants": [
      123
    ],
    "consumerStatus": "SOLD",
    "consumerFirstName": "<string>",
    "consumerMiddleName": "<string>",
    "consumerLastName": "<string>",
    "consumerSuffix": "<string>",
    "consumerDateOfBirth": "<string>",
    "consumerEducationLevel": "<string>",
    "consumerVehicles": [
      123
    ],
    "consumerPhoneType": "<string>",
    "consumerDriversLicense": "<string>",
    "consumerDriversLicenseState": "<string>",
    "consumerDriversLicenseNumber": "<string>",
    "consumerDriversLicenseExp": "<string>",
    "consumerDriversLicenseExpiration": "<string>",
    "consumerPreApprovals": [
      123
    ],
    "consumerGetPreApproved": "<string>",
    "consumerProvideProofOfInsurance": "<string>",
    "consumerLoginToBank": "<string>",
    "consumerConnectCar": "<string>",
    "consumerProvideProofOfIncome": "<string>",
    "consumerConsumerId": "<string>",
    "consumerCreditApplicationId": "<string>",
    "deals2": [
      123
    ],
    "consumerSocialSecurity": "<string>",
    "consumerDriversLicenceState": "<string>",
    "consumerIncome": 123,
    "consumerIncomeInterval": "<string>",
    "consumerEmploymentStatusCode": "<string>",
    "consumerEmploymentDuration": 123,
    "consumerEmployerName": "<string>",
    "consumerEmployerPhone": "<string>",
    "consumerEmploymentTitle": "<string>",
    "consumerPreviousEmployerName": "<string>",
    "consumerPreviousEmployerPhone": "<string>",
    "consumerPreviousEmploymentTitle": "<string>",
    "consumerPreviousEmploymentDuration": 123,
    "consumerPreviousEmploymentincome": 123,
    "consumerTimeAtResidence": 123,
    "consumerPreviousAddressLine1": "<string>",
    "consumerPreviousAddressLine2": "<string>",
    "consumerPreviousAddressCity": "<string>",
    "consumerPreviousAddressState": "<string>",
    "consumerPreviousZip": "<string>",
    "consumerPreviousAddressDuration": 123,
    "consumerResidenceType": "<string>",
    "consumerRentMortgage": 123,
    "consumerOtherIncomeDescription": "<string>",
    "consumerOtherIncomeAmount": 123,
    "consumerLeadSource": [
      "Car Concierge (Andrew)"
    ],
    "companyName": "<string>",
    "companyDealerDeals": [
      123
    ],
    "companyDealsFacilitated": [
      123
    ],
    "companyInsuranceQuotes": [
      123
    ],
    "companyType": [
      "Dealer"
    ],
    "companyWebsite": "<string>",
    "companyStripeConnectLink": "<string>",
    "companyCustomerPortalLink": "<string>",
    "companyServiceQuotes": [
      123
    ],
    "companyServiceOrders": "<string>",
    "companyServiceQuotesPartners": [
      123
    ],
    "companyVisibility": "<string>",
    "companyTenants2": [
      123
    ],
    "companyCustomer": [
      123
    ],
    "companyTrades": [
      123
    ],
    "companyTenants3": [
      123
    ],
    "companyPartnerBrand": 123,
    "companyDeals3": [
      123
    ],
    "companyRouteOneDealer": "<string>",
    "companyTransportServiceOrders": [
      123
    ]
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { customers } from '@drivly/commerce'

const sdk = new SDK(...)

const customers = await sdk.customers.create(data: customers): Promise<customers>

Authorizations

​
Authorization
string
header
required

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
customerId
string | null
​
leads
(number | Lead · object)[] | null
​
address
​
shippingContact
​
deals
(number | Deal · object)[] | null
​
createdBy
number
​
lastModifiedBy
number
​
email
string | null
​
phone
string | null
​
insurancePolicies
(number | InsurancePolicy · object)[] | null
​
tenants
(number | Tenant · object)[] | null
​
consumerStatus
enum<string> | null
Available options:
SOLD,
Pending,
Working,
Cold,
LOST,
Duplicate,
DNC
​
consumerFirstName
string | null
​
consumerMiddleName
string | null
​
consumerLastName
string | null
​
consumerSuffix
string | null
​
consumerDateOfBirth
string | null
​
consumerEducationLevel
string | null
​
consumerVehicles
(number | Vehicle · object)[] | null
​
consumerPhoneType
string | null
​
consumerDriversLicense
string | null
​
consumerDriversLicenseState
string | null
​
consumerDriversLicenseNumber
string | null
​
consumerDriversLicenseExp
string | null
​
consumerDriversLicenseExpiration
string | null
​
consumerPreApprovals
(number | PreApproval · object)[] | null
​
consumerGetPreApproved
string | null
​
consumerProvideProofOfInsurance
string | null
​
consumerLoginToBank
string | null
​
consumerConnectCar
string | null
​
consumerProvideProofOfIncome
string | null
​
consumerConsumerId
string | null
​
consumerCreditApplicationId
string | null
​
deals2
(number | Deal · object)[] | null
​
consumerSocialSecurity
string | null
​
consumerDriversLicenceState
string | null
​
consumerIncome
number | null
​
consumerIncomeInterval
string | null
​
consumerEmploymentStatusCode
string | null
​
consumerEmploymentDuration
number | null
​
consumerEmployerName
string | null
​
consumerEmployerPhone
string | null
​
consumerEmploymentTitle
string | null
​
consumerPreviousEmployerName
string | null
​
consumerPreviousEmployerPhone
string | null
​
consumerPreviousEmploymentTitle
string | null
​
consumerPreviousEmploymentDuration
number | null
​
consumerPreviousEmploymentincome
number | null
​
consumerTimeAtResidence
number | null
​
consumerPreviousAddressLine1
string | null
​
consumerPreviousAddressLine2
string | null
​
consumerPreviousAddressCity
string | null
​
consumerPreviousAddressState
string | null
​
consumerPreviousZip
string | null
​
consumerPreviousAddressDuration
number | null
​
consumerResidenceType
string | null
​
consumerRentMortgage
number | null
​
consumerOtherIncomeDescription
string | null
​
consumerOtherIncomeAmount
number | null
​
consumerLeadSource
enum<string>[] | null
Available options:
Car Concierge (Andrew),
Driv.ly Website,
Self Generated,
Referral,
Rocket
​
companyName
string | null
​
companyDealerDeals
(number | Deal · object)[] | null
​
companyDealsFacilitated
(number | Deal · object)[] | null
​
companyInsuranceQuotes
(number | InsuranceQuote · object)[] | null
​
companyType
enum<string>[] | null
Available options:
Dealer,
Concierge,
Broker,
Partner,
Auction,
Affiliate,
Insurer,
Mobile Detailer,
Last Mile Transporter,
Service Provider,
Lender
​
companyWebsite
string | null
​
companyStripeConnectLink
string | null
​
companyCustomerPortalLink
string | null
​
companyServiceQuotes
(number | ServiceQuote · object)[] | null
​
companyServiceOrders
string | null
​
companyServiceQuotesPartners
(number | ServiceQuote · object)[] | null
​
companyVisibility
string | null
​
companyTenants2
(number | Tenant · object)[] | null
​
companyCustomer
(number | Customer · object)[] | null
​
companyTrades
(number | Trade · object)[] | null
​
companyTenants3
(number | Tenant · object)[] | null
​
companyPartnerBrand
​
companyDeals3
(number | Deal · object)[] | null
​
companyRouteOneDealer
string | null
​
companyTransportServiceOrders
(number | ServiceOrder · object)[] | null

Response

200 - application/json

ok

​
doc
Customer · object
required
​
message
string
required