Skip to main content
POST
/
api
/
v1
/
leads
curl -X POST https://lupitor.acrely.ai/api/v1/leads \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "k978z8ndfnqjnbxmphvf0wd59h6yrd0a",
    "phoneNumber": "+15555551234",
    "externalId": "CRM_12345",
    "metadata": {
      "name": "John Doe",
      "company": "Acme Corp",
      "industry": "Technology",
      "notes": "Interested in premium plan"
    },
    "scheduledFor": "2024-12-25T09:00:00Z",
    "priority": 10
  }'

{
  "success": true,
  "data": {
    "leadId": "jh7abc123xyz"
  },
  "error": null
}

​
Authentication

​
x-api-key
string
required
Your API key with write scope

​
Request Body

​
campaignId
string
required
The ID of the campaign this lead belongs to
​
phoneNumber
string
required
Lead’s phone number in E.164 format (e.g., +15555551234)
​
externalId
string
Your CRM’s internal ID for this lead
​
metadata
object
Custom data about the lead (name, company, notes, etc.)
​
scheduledFor
string
ISO 8601 timestamp for when to call this lead
​
priority
number
default:"0"
Lead priority (higher = called first). Range: 0-100

​
Response

​
success
boolean
Whether the request was successful
​
data
object
​
error
string | null
Error message if request failed
curl -X POST https://lupitor.acrely.ai/api/v1/leads \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "k978z8ndfnqjnbxmphvf0wd59h6yrd0a",
    "phoneNumber": "+15555551234",
    "externalId": "CRM_12345",
    "metadata": {
      "name": "John Doe",
      "company": "Acme Corp",
      "industry": "Technology",
      "notes": "Interested in premium plan"
    },
    "scheduledFor": "2024-12-25T09:00:00Z",
    "priority": 10
  }'

{
  "success": true,
  "data": {
    "leadId": "jh7abc123xyz"
  },
  "error": null
}

​
Notes

Duplicate Prevention: If a lead with the same phone number already exists in this campaign, the request will fail.
Scheduling: If you don’t provide scheduledFor, the lead will be called as soon as possible based on business hours and priority.
Phone Format: Phone numbers must be in E.164 format (+ and country code). Example: +15555551234

​
Common Errors

ErrorCauseSolution
campaignId is requiredMissing campaignIdInclude campaignId in request body
phoneNumber is requiredMissing phoneNumberInclude phoneNumber in request body
Invalid or inactive API keyWrong API keyCheck your API key
Campaign not found or access deniedWrong campaign or no accessVerify campaignId and API key scope
Lead already existsDuplicate phone numberPhone number already exists in campaign