Create Customer

Create a customer in the current company. App connections need the booking:write or inventory:write scope.

POST

/api/v1/customer

POST

/customer

curl -X POST "https://dash.lockii.app/api/v1/customer" \
  -H "x-api-key: $LOCKII_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string"
}'

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Body

application/json

id
string
required
Customer ID, usually customer_<uuid>
name
string
Customer first name
Default:
lastName
string
Customer last name
Default:
email
string
Customer email address
Default:
phone
string
Customer phone number
Default:
phoneCode
string
Phone country/area code
Default:
address
string
Street address
Default:
city
string
City
Default:
state
string
State, region, or province
Default:
zip
string
Postal/zip code
Default:
country
string
Country
Default:
companyID
string
Company ID. Defaults to the authenticated user's company.
createdAt
number
Unix ms. Defaults to now.
updatedAt
number
Unix ms. Defaults to now.
stripeCustomerID
string
Stripe customer ID
Default:
verification
string | null
identityVerificationID
string | null
identityLink
string | null
identityExpiresAt
number | null
blocked
boolean
blockedAt
number | null
blockedReason
string | null

Response

application/json

JSON result for this operation.

object

{}