Submit leads to an agent | Documentation

Submit one or more leads to a specific SimZ agent for outbound calling.

X-Company-API-Keystring

Company API key issued by SimZ.

agentIdstringRequired

SimZ agent ID that should receive the leads.

This endpoint expects an object.

leadslist of objectsRequired

Leads to submit to the target agent.

optionsobjectOptional

All submitted leads were accepted.

successboolean

batchIdstring or null

Batch identifier for the submitted leads when returned.

acceptedinteger>=0

rejectedinteger>=0

errorslist of objects

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

$	curl -X POST https://api.simz.com/api/lead-receive-service/agent/receiveLead/agentId \
>	-H "X-Company-API-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"leads": [
>	{
>	"phoneNumber": "+14155552671",
>	"firstName": "Michael",
>	"lastName": "Thompson",
>	"customData": {
>	"leadId": "LEAD-789",
>	"campaignTag": "summer-sale-2024"
>	}
>	}
>	],
>	"options": {
>	"priority": "normal"
>	}
>	}'