Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

Tolt API key sent as a bearer token.

Body

application/json

Send at least one of email or customer_id to identify the customer, and at least one of partner_id or link_id to attribute them. A request missing either returns 400.

email
string

Customer's email, stored lowercased and used as their identifier. It must not belong to another customer. Provide this or customer_id.

Required string length: 1 - 255
promotion_code
string

Resolve a code in the partner’s program, ignoring case, preferring partner, group, then program scope. An unmatched code leaves attribution unchanged.

Minimum string length: 1
created_at
string<date-time>

When the customer was created, for backdating. Defaults to now; lead_at, and active_at for active customers, default to it.

name
string

Customer's full name as you want it shown in the dashboard; it does not affect attribution or matching.

Maximum string length: 255
customer_id
string

Customer's id in your billing system, such as a Stripe customer id. The billing integration matches payments to this customer by it. Provide this or email.

Required string length: 1 - 255
status
enum<string>

Lifecycle stage of the customer. Defaults to lead (signed up, not paying yet); recording a transaction for the customer makes them active.

Available options:
lead,
active,
canceled,
suspended,
trialing
subscription_id
string

Customer's subscription id in your billing system, such as a Stripe subscription id.

Maximum string length: 255
click_id
string

Id of the tracked click the customer came from, as returned when listing clicks. It must belong to the partner, and its link is used when link_id is omitted.

Id of the referral link the customer came through (lnk_...). Without partner_id the link's partner is used; with it, the link must belong to that partner.

partner_id
string

Id of the partner who referred the customer (part_...), as returned when listing partners. The customer joins that partner's program. Provide this or link_id.

lead_at
string<date-time> | null

When the customer signed up as a lead, as a timestamp with a time zone, for example 2026-03-01T12:00:00Z. Defaults to created_at.

active_at
string<date-time> | null

When the customer became a paying customer, as a timestamp with a time zone. Defaults to created_at when status is active, otherwise it is set when a transaction is recorded for the customer.

Response

The created customer

success
boolean
required
Example:

true

message
string
required
Example:

"Request successful"

data
object
required