Skip to main content
POST
/
api
/
v1
/
leads
/
capture
curl --request POST \
  --url https://app.mlm-platform.com/api/v1/leads/capture \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-api-key: <api-key>' \
  --data '
{
  "email": "lead@example.com"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "name": "<string>",
  "referrer_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversion_status": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-tenant-api-key
string
header
required

Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.

Body

application/json
​
email
string<email>
required

Lead email address (normalized to lowercase)

​
name
string

Optional display name for the lead

Maximum string length: 255
​
phone
string

Optional phone number for the lead

​
referral_code
string

Referral code for attribution

​
source
string

Lead source (e.g., "landing_page", "social")

Maximum string length: 100
​
utm_source
string

UTM source

​
utm_medium
string

UTM medium

​
utm_campaign
string

UTM campaign

Response

Lead captured successfully

​
id
string<uuid>

Lead UUID

​
email
string<email>

Lead email address

​
name
string | null

Optional display name

​
referrer_user_id
string<uuid> | null

Referrer MLM user ID, if attribution succeeded

​
conversion_status
string

Lead conversion status

​
created_at
string<date-time>

Lead creation timestamp