Skip to main content
POST
Only name and email are required, so a CRM workflow can create a customer straight from a contact. Add send_invite to email the customer a link to set up their portal login. Each email can belong to one active customer in your account. An archived customer’s email can be used for a new customer. To check whether a contact is already a customer, look them up by email first. Send an Idempotency-Key header so a retried request can never create a second customer. See Safe retries.

Authorizations

Authorization
string
header
required

An API key from Configure → API Keys (it starts with jz_live_), sent as a bearer token. See API Keys.

Headers

Idempotency-Key
string

Any string, such as your CRM's contact ID. A retry with the same key and body within 24 hours returns the original response.

Maximum string length: 255

Body

application/json
name
string
required

The customer's business or display name.

Maximum string length: 255
email
string<email>
required

Must include a domain with a TLD. Unique across your active customers. An archived customer's email can be used again.

Maximum string length: 255
phone
string

A US, Canadian, Australian or Latvian phone number.

address
string
Maximum string length: 255
address_2
string
Maximum string length: 255
city
string
Maximum string length: 255
state
string
Maximum string length: 255
zip
string

Checked against country, which is required with it.

country
enum<string>

Required when state or zip is sent.

Available options:
US,
CA,
AU,
LV
paused
boolean
default:false
can_access_bidding
boolean
default:false
can_access_club
boolean
default:false
daily_lead_cap
integer

Most leads a day. Accepted only when the matching cap or budget is turned on in your account settings, and ignored otherwise.

Required range: 1 <= x <= 2147483647
weekly_lead_cap
integer

Most leads a week. Accepted only when the matching cap or budget is turned on in your account settings, and ignored otherwise.

Required range: 1 <= x <= 2147483647
monthly_lead_cap
integer

Most leads a month. Accepted only when the matching cap or budget is turned on in your account settings, and ignored otherwise.

Required range: 1 <= x <= 2147483647
daily_budget
number

Most spent a day, in dollars. Accepted only when the matching cap or budget is turned on in your account settings, and ignored otherwise.

Required range: 1 <= x <= 21474836
weekly_budget
number

Most spent a week, in dollars. Accepted only when the matching cap or budget is turned on in your account settings, and ignored otherwise.

Required range: 1 <= x <= 21474836
monthly_budget
number

Most spent a month, in dollars. Accepted only when the matching cap or budget is turned on in your account settings, and ignored otherwise.

Required range: 1 <= x <= 21474836
send_invite
boolean
default:false

Email the customer an invite to set up their portal login.

Response

Customer created. A retry with the same Idempotency-Key and body returns this same response again, with an Idempotent-Replayed: true header.

data
Customer · object
version
enum<string>
Available options:
v1