Create a lead - ChakraHQ APIs

Use this api to create a lead. Be sure that your team has a lead module before using this API.

In the sample payload, we have provided an example on how to pass the following attributes while creating a lead

name - Name of the lead (optional)

phone_number - Phone number of the lead (optional)

email - Email of the lead (optional)

Please note that if you add custom fields to your lead, you can pass data for those fields by appending a value for the custom attribute short id inside the data section of the payload.

You can check all the attributes available in your lead model by going to Admin > Lead > Attributes section

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
  "data": {
    "name": "John Deere",
    "phone_number": "919910122334",
    "email": "john.deere@example.com"
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
  "_data": {
    "id": "6d84671a-0c73-49c4-a9c6-965c074dcb1f",
    "createdAt": 1757306761947,
    "updatedAt": 1757306761947,
    "skills": null,
    "status": "OPEN",
    "data": {
      "phone_number": "+919910122334",
      "email": "john.deere@example.com",
      "lead_id": "LEAD-000001",
      "name": "John Deere"
    },
    "derivedData": {},
    "kanbanOrder": null,
    "meta": null,
    "nextActionAt": null,
    "completedAt": null,
    "cancelledAt": null,
    "firstAssignedAt": null,
    "lastAssignedAt": null,
    "previousAssignedAt": null,
    "origin": "API",
    "originId": "/v1/ext/procedure/lead/process",
    "originRunId": null,
    "lastEmailMessageAt": null,
    "lastEmailMessageDirection": null,
    "lastChatMessageAt": null,
    "lastChatMessageDirection": null,
    "escalationLevel": null,
    "slaData": null,
    "nextSlaActionAt": null,
    "isDeleted": false,
    "searchVector": null,
    "primaryShipmentStatus": null,
    "primaryShipmentLastEventTs": null,
    "stateChangedAt": 1757306761947,
    "timeSpentInState": null,
    "autoDial": null,
    "deDuplication": null,
    "tags": null,
    "contacts": null,
    "contactLabels": null,
    "team": "f6d26084-c693-45a3-92e8-b887a5d80716",
    "procedure": "9ee4a888-31f3-40af-8d21-8e9a1da5d005",
    "createdBy": "e39ba3e7-1ff0-47f9-8ec5-0b8a1a1a4623",
    "assignedTo": null,
    "belongsTo": null,
    "entity": "5edcb0b4-88ea-4af3-a0bc-38f0da8246f5",
    "record": null,
    "contact": null,
    "company": null,
    "state": "1f4212d2-ac8a-48a2-b45f-d17f40c474eb",
    "primaryBooking": null,
    "parentProcedure": null,
    "parentProcess": null,
    "firstAssignedTo": null,
    "previousAssignedTo": null,
    "lastEmailMessage": null,
    "lastChatMessage": null,
    "primaryShipment": null,
    "processTemplate": null
  },
  "_meta": {
    "processHistory": [
      {
        "id": "bb437525-4c64-453e-9636-139dec5d64d7",
        "createdAt": 1757306762605,
        "updatedAt": 1757306762605,
        "operation": "CREATED",
        "operatedBy": "e39ba3e7-1ff0-47f9-8ec5-0b8a1a1a4623",
        "operatedAt": 1757306761947,
        "operationSource": {
          "sourceType": "API",
          "inboundApiLogId": "2025-09-08-04-46-01-832-1-4718cabf72"
        },
        "oldValue": null,
        "newValue": {
          "id": "6d84671a-0c73-49c4-a9c6-965c074dcb1f",
          "data": {
            "28b0d0af-41e9-4f7c-8f95-9c0bf88ca4ea": "+919910122334",
            "45f5408a-f31d-4684-9cbf-129f88dd99bf": "john.deere@example.com",
            "a15ad0b2-211e-4c8c-b7bf-9b736978caab": "LEAD-000001",
            "a84a2940-2b56-42e9-936e-296d7fed034c": "John Deere"
          },
          "meta": null,
          "tags": null,
          "team": "f6d26084-c693-45a3-92e8-b887a5d80716",
          "state": "1f4212d2-ac8a-48a2-b45f-d17f40c474eb",
          "entity": "5edcb0b4-88ea-4af3-a0bc-38f0da8246f5",
          "origin": "API",
          "record": null,
          "skills": null,
          "status": "OPEN",
          "company": null,
          "contact": null,
          "slaData": null,
          "autoDial": null,
          "contacts": null,
          "originId": "/v1/ext/procedure/lead/process",
          "belongsTo": null,
          "createdAt": 1757306761947,
          "createdBy": "e39ba3e7-1ff0-47f9-8ec5-0b8a1a1a4623",
          "isDeleted": false,
          "procedure": "9ee4a888-31f3-40af-8d21-8e9a1da5d005",
          "updatedAt": 1757306761947,
          "assignedTo": null,
          "cancelledAt": null,
          "completedAt": null,
          "derivedData": null,
          "kanbanOrder": null,
          "originRunId": null,
          "nextActionAt": null,
          "searchVector": null,
          "contactLabels": null,
          "deDuplication": null,
          "parentProcess": null,
          "lastAssignedAt": null,
          "primaryBooking": null,
          "stateChangedAt": 1757306761947,
          "escalationLevel": null,
          "firstAssignedAt": null,
          "firstAssignedTo": null,
          "lastChatMessage": null,
          "nextSlaActionAt": null,
          "parentProcedure": null,
          "primaryShipment": null,
          "processTemplate": null,
          "lastEmailMessage": null,
          "timeSpentInState": null,
          "lastChatMessageAt": null,
          "lastEmailMessageAt": null,
          "previousAssignedAt": null,
          "previousAssignedTo": null,
          "primaryShipmentStatus": null,
          "lastChatMessageDirection": null,
          "lastEmailMessageDirection": null,
          "primaryShipmentLastEventTs": null
        },
        "oldSkillMappings": null,
        "newSkillMappings": null,
        "logs": {},
        "isSyncedOnCH": true,
        "team": "f6d26084-c693-45a3-92e8-b887a5d80716",
        "process": "6d84671a-0c73-49c4-a9c6-965c074dcb1f",
        "procedure": "9ee4a888-31f3-40af-8d21-8e9a1da5d005"
      }
    ]
  }
}