Skip to main content
POST
/
api
/
leads
/
sync
Bulk sync leads
curl --request POST \
  --url https://api.naturalead.ai/api/leads/sync \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "leads": [
    {
      "lead_id": "<string>",
      "phone": "<string>",
      "name": "<string>",
      "email": "[email protected]",
      "custom_fields": {}
    }
  ]
}
'
{
  "total": 123,
  "created": 123,
  "updated": 123,
  "failed": 123,
  "errors": [
    {
      "lead_id": "<string>",
      "error": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

API key passed via the X-API-Key header.

Body

application/json
leads
object[]
required

Array of leads to sync.

Response

Sync completed successfully.

total
integer

Total number of leads processed.

created
integer

Number of new leads created.

updated
integer

Number of existing leads updated.

failed
integer

Number of leads that failed to sync.

errors
object[]

Details for each failed lead.