Skip to main content
POST
Add a customer or lead manually

Authorizations

x-api-key
string
header
required

Team API key for authentication. Your team role (provider/reseller/hybrid) determines which endpoints you can access.

Body

application/json
firstName
string
Example:

"Jane"

lastName
string
Example:

"Doe"

fullName
string

Legacy single-field name — prefer firstName + lastName. Required only when both are absent; split on the last space when used.

Example:

"Jane Doe"

email
string
Example:

"jane@example.com"

phone
string
Example:

"+1-555-123-4567"

addressLine1
string
Example:

"123 Main St"

addressLine2
string
Example:

"Apt 4B"

city
string
Example:

"San Francisco"

state
string
Example:

"CA"

postalCode
string
Example:

"94102"

country
string
Example:

"US"

kind
enum<string>
default:lead

Whether to track as a lead (pre-order) or as a customer.

Available options:
lead,
customer
source
enum<string>
default:manual

Where this contact came from.

Available options:
order,
link,
api_import,
manual,
event,
shop,
reseller
notes
string
tags
string[]
customFields
object

Open-ended attributes (source URL, external IDs, etc.)

Example:

Response

Customer created