Create Customer

curl -X POST 'https://api.tolt.com/v1/customers' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "email": "cust_123",
    "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
    "name": "Jim Halpert",
    "subscription_id": "sub_456",
    "customer_id": "jim_halpert_789",
    "click_id": "click_abc",
    "promotion_code": "PARTNER20",
    "status": "active",
    "active_at": "2025-01-15T14:30:00.000Z"
}'

{
  "success": true,
  "data": [
    {
      "id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "customer_id": "jim_halpert_789",
      "identifier": "james@tolt.com",
      "email": "james@tolt.com",
      "name": "Jim Halpert",
      "status": "active",
      "plan": null,
      "subscription_id": "sub_456",
      "lead_at": "2025-04-25T11:00:00.797Z",
      "active_at": "2025-01-15T14:30:00.000Z",
      "click_id": "click_abc",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "created_at": "2025-04-25T11:00:00.800Z",
      "updated_at": "2025-04-25T11:00:00.800Z",
      "promotion_code_id": "promo_abc"
    }
  ]
}

POST

customers

curl -X POST 'https://api.tolt.com/v1/customers' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "email": "cust_123",
    "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
    "name": "Jim Halpert",
    "subscription_id": "sub_456",
    "customer_id": "jim_halpert_789",
    "click_id": "click_abc",
    "promotion_code": "PARTNER20",
    "status": "active",
    "active_at": "2025-01-15T14:30:00.000Z"
}'

{
  "success": true,
  "data": [
    {
      "id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "customer_id": "jim_halpert_789",
      "identifier": "james@tolt.com",
      "email": "james@tolt.com",
      "name": "Jim Halpert",
      "status": "active",
      "plan": null,
      "subscription_id": "sub_456",
      "lead_at": "2025-04-25T11:00:00.797Z",
      "active_at": "2025-01-15T14:30:00.000Z",
      "click_id": "click_abc",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "created_at": "2025-04-25T11:00:00.800Z",
      "updated_at": "2025-04-25T11:00:00.800Z",
      "promotion_code_id": "promo_abc"
    }
  ]
}

Base URL `https://api.tolt.com`

Body Parameters

string

Customer’s email address

string

The partner ID who referred this customer

string - optional

Customer’s name

string - optional

Associated subscription identifier

string - optional

Your internal customer identifier

string - optional

Tracking click identifier

string - optional

Promotion code used to attribute this customer. The code must belong to the referring partner, their group, or their program. If it does not match, the customer is still created using click or API attribution, and the response includes a warnings array with a promotion_code_not_applied entry.

string - optional

ISO 8601 timestamp of when the customer was created

string - optional

ISO 8601 timestamp of when the customer became a lead

string - optional

ISO 8601 timestamp of when the customer became active

string - optional

Customer’s status. Valid values are: ‘lead’, ‘trialing’, ‘active’, ‘canceled’

Response

boolean

Whether the request was successful

array[object]

Hide properties

string

Unique identifier for the customer, uuid or prefixed with cust_

string

Your unique identifier for the customer

string

ID of the referring partner

string

Customer’s name

string

Associated subscription identifier

string

Customer identifier

string

Your internal customer identifier

string

Tracking click identifier

string

ISO 8601 timestamp of creation

string

ISO 8601 timestamp of lead conversion

string

ISO 8601 timestamp of activation

string

ISO 8601 timestamp of updated customer

string

Customer’s current status

string | null

Plan the customer subscribed to

string | null

Identifier for a promotoinal code used by the customer

string

Program ID the customer belongs to

string

Organization ID

curl -X POST 'https://api.tolt.com/v1/customers' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
    "email": "cust_123",
    "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
    "name": "Jim Halpert",
    "subscription_id": "sub_456",
    "customer_id": "jim_halpert_789",
    "click_id": "click_abc",
    "promotion_code": "PARTNER20",
    "status": "active",
    "active_at": "2025-01-15T14:30:00.000Z"
}'

{
  "success": true,
  "data": [
    {
      "id": "cust_dK9bzRGn46BhVgNFHD6fDgXW",
      "customer_id": "jim_halpert_789",
      "identifier": "james@tolt.com",
      "email": "james@tolt.com",
      "name": "Jim Halpert",
      "status": "active",
      "plan": null,
      "subscription_id": "sub_456",
      "lead_at": "2025-04-25T11:00:00.797Z",
      "active_at": "2025-01-15T14:30:00.000Z",
      "click_id": "click_abc",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2",
      "created_at": "2025-04-25T11:00:00.800Z",
      "updated_at": "2025-04-25T11:00:00.800Z",
      "promotion_code_id": "promo_abc"
    }
  ]
}

tolt.js

Guides / How To

Programs

Partners

Customers

Clicks

Links

Commissions

Transactions

Promotion Codes

Base URL `https://api.tolt.com`

Body Parameters

Response

​Base URL https://api.tolt.com

​Body Parameters

​Response

Base URL `https://api.tolt.com`

Body Parameters

Response