Skip to main content
POST
Create customer

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Headers

idempotency-key
string

Key that makes this request safe to retry. Reuse the same value when retrying a request that may already have succeeded — the original response is replayed with an Idempotency-Replay: true header. Use a new value for a new operation.

Required string length: 1 - 255
Example:

"9f8c2b1a-4d3e-4a6b-8c1d-2e3f4a5b6c7d"

Body

application/json
businessId
string<uuid>
required
type
enum<string>
required

Whether the customer is a person or a company

Available options:
individual,
business
Example:

"individual"

contactId
string<uuid> | null
name
string | null
email
string | null
phone
string | null
notes
string | null
status
enum<string>

Where the relationship stands; a new customer defaults to active

Available options:
prospect,
active,
inactive
Example:

"active"

customerSince
string<date-time> | null

Response

Customer created successfully

data
object
required
meta
object
Last modified on October 6, 2026