Quickstart | Documentation

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. If a batchId is returned, keep it for support and troubleshooting references.