Integrations
API Reference
Programmatically create and manage leads in your ConvertIQ account using our REST API.
Authentication
All API requests must include your API key in the X-API-Key header.
Header
X-API-Key: ciq_your_api_key_here
Generate API Key
Go to Settings → API Key to generate your key
Create Lead Endpoint
POST
https://convertiq.me/api/external/leads/createContent-Type: application/json
X-API-Key: YOUR_API_KEY
Request Body
{
"lead": {
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "15551234567",
"source": "Website Form",
"industry": "Technology",
"score": 7,
"status": "contacted",
"monthly_revenue": 50000,
"budget": 10000,
"description": "Interested in AI calling"
}
}Response
{
"success": true,
"lead": {
"id": "uuid",
"user_id": "uuid",
"name": "Jane Doe",
"email": "jane@example.com",
"source": "Website Form",
"industry": "Technology",
"status": "contacted",
"created_at": "2025-08-13T00:00:00.000Z"
}
}cURL Example
curl -X POST https://convertiq.me/api/external/leads/create \
-H "Content-Type: application/json" \
-H "X-API-Key: ciq_your_api_key_here" \
-d '{
"lead": {
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "15551234567",
"source": "API",
"industry": "Technology"
}
}'Field Reference
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Lead's full name |
| string | Yes | Lead's email address | |
| phone | string | Recommended | E.164 format without + (e.g., 15551234567) |
| source | string | Yes | Lead source (e.g., "Website", "API") |
| industry | string | Yes | Industry/vertical |
| score | number | No | Lead quality score (1-10) |
| status | string | No | new, contacted, qualified, lost |
| monthly_revenue | number | No | Estimated monthly revenue |
| budget | number | No | Lead's budget |
| description | string | No | Additional notes |
Important Notes
- Authentication: Include your API key in the X-API-Key header
- Required fields: name, email, source, industry
- Phone format: Use E.164 format without + (e.g., 15551234567)
- Rate limiting: 100 requests per minute per API key