Create or upsert up to 500 leads

POST

https://api.levrage.ai/v1/crm/leads/bulk

POST

/v1/crm/leads/bulk

import requests
url = "https://api.levrage.ai/v1/crm/leads/bulk"
payload = {
    "leads": [
        {
            "name": "Amit Kumar",
            "phone": "9876543210",
            "external_id": "12345",
            "city": "Hyderabad",
            "fields": {
                "Zone": "Madhapur",
                "Week": "43",
                "Plan": "Gold"
            },
            "source": "google_sheet",
            "on_conflict": "update"
        },
        {
            "name": "Ravi Teja",
            "phone": "9876500002",
            "external_id": "12346",
            "city": "Hyderabad",
            "fields": {
                "Zone": "Madhapur",
                "Week": "43",
                "Plan": "Gold"
            },
            "source": "google_sheet",
            "on_conflict": "update"
        }
    ],
    "on_conflict": "update",
    "create_missing_fields": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "results": [
    {
      "index": 1,
      "result": "created",
      "lead_id": "string",
      "error": {}
    }
  ],
  "created": 1,
  "updated": 1,
  "unchanged": 1,
  "failed": 1,
  "created_fields": [
    {
      "key": "string",
      "label": "string"
    }
  ],
  "missing_fields": [
    "string"
  ]
}

Each row succeeds or fails on its own; results has one entry per row in order. on_conflict, match_on and create_missing_fields apply to every row unless the row sets its own. For a large sheet, send chunks of 500 with one Idempotency-Key each.

Request

This endpoint expects an object.

leadslist of objectsRequired

on_conflictenum or nullOptional

Allowed values:

match_onlist of enums or nullOptional

Allowed values:

create_missing_fieldsboolean or nullOptional

Response

Successful Response

resultslist of objects

createdinteger

updatedinteger

unchangedinteger

failedinteger

created_fieldslist of objects or nullOptional

missing_fieldslist of strings or nullOptional

Every custom field name sent that doesn’t exist, once (rows naming them failed).

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

Headers

Request

Response

Errors