Skip to navigation

Quickstart

View as Markdown

The Lead Receive API lets your CRM or application submit leads to a specific SimZ agent. SimZ validates the leads, creates a batch, and queues outbound calls.

Base path

/api/lead-receive-service

Basic request

curl -X POST "https://api.simz.com/api/lead-receive-service/agent/receiveLead/agent_123" \
-H "Content-Type: application/json" \
-H "X-Company-API-Key: sk_comp_example" \
-d '{
"leads": [
{
"phoneNumber": "+15551234567",
"firstName": "Jane",
"lastName": "Doe",
"customData": {
"leadId": "LEAD-001",
"campaignTag": "spring-2026"
}
}
],
"options": {
"priority": "normal"
}
}'

Response

A successful request returns accepted and rejected counts and a batchId when a batch is created.

{
"success": true,
"message": "Leads received and queued successfully",
"data": {
"batchId": "batch_123",
"agentId": "agent_123",
"agentName": "Spring Outreach",
"totalLeads": 1,
"acceptedLeads": 1,
"rejectedLeads": 0,
"estimatedStartTime": "2026-07-06T18:30:00Z",
"rejectedLeadDetails": []
}
}

Save the batchId in your CRM or application. Use it with the Batch Management endpoints to check status, pause dialing, resume a paused batch, or cancel remaining accepted backlog.

Next steps