Skip to main content
POST
/
v1
/
leads
Lead
curl --request POST \
  --url https://api.example.com/v1/leads

Documentation Index

Fetch the complete documentation index at: https://docs.reachedapp.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Create a Lead

Creates a new lead in your workspace. At least a phone number or email address is required.

​
Request

POST /v1/leads

​
Body Parameters

ParameterTypeRequiredDescription
first_namestringNoFirst name of the lead
last_namestringNoLast name of the lead
emailstringConditionalEmail address (required if no phone)
phonestringConditionalPhone number in E.164 format (required if no email)
company_namestringNoCompany or organization name
titlestringNoJob title
linkedin_urlstringNoLinkedIn profile URL
company_websitestringNoCompany website URL
job_descriptionstringNoJob description or role details
company_sizestringNoCompany size range (e.g., “11-50”)
custom_variablesobjectNoKey-value pairs for custom data
metadataobjectNoAdditional metadata as JSON
At least one of phone or email must be provided. Phone numbers should be in E.164 format (e.g., +33612345678).

​
Example

curl -X POST \
  "https://YOUR_PROJECT.supabase.co/functions/v1/api-gateway/v1/leads" \
  -H "Authorization: Bearer rchd_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@acme.com",
    "phone": "+33612345678",
    "company_name": "Acme Corp",
    "title": "VP Sales"
  }'

​
Response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@acme.com",
    "phone": "+33612345678",
    "company_name": "Acme Corp",
    "title": "VP Sales",
    "status": "pending",
    "source": "api",
    "created_at": "2026-03-21T10:00:00.000Z"
  }
}