🚀 Create a New Lead Using API

API usage example for creating a Lead with Agency Handy API

Prerequisites

Review the steps in the Getting Started guide before updating an order. It walks through configuring your API token, and selecting the correct companyid, which are all required for the instructions below.

Step 1: Get Client Role ID

📍 Endpoint:

{{URL}}/roles?type=company

🛠️ Set Headers:

x-api-key: <API_KEY>
companyid: <COMPANY_ID>

📥 Response Example:

{
  "roles": [
    {
      "_id": "6525994184e9ddd798534535",
      "role": {
        "_id": "6525994184e9ddd79853451e",
        "responsibility": "",
        "name": "client"
      },
      "company": "6525994184e9ddd79853450e",
      "createdAt": "2023-10-10T18:34:41.567Z",
      "updatedAt": "2024-10-01T07:28:48.340Z",
      "__v": 0,
      "type": "company"
    }
  ]
}

📝 What to Do:

• Find the role where roles[0].role.name === "client".

• Extract and store the Client Role ID:

  const clientRoleId = "ROLE_ID_HERE"; // Replace with actual ID

• Important: Ensure you do not copy _id from roles[0].role, but from roles[0] itself.

Step 2: Create a New Lead

📍 Endpoint:

{{URL}}/company/{{companyId}}/members/bulk-client

🛠️ Set Headers:

x-api-key: <API_KEY>
companyid: <COMPANY_ID>

📦 Request Body:

   [
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "role": "ROLE_ID_HERE",
      "isConvertedClient": false,
      "status": "New",
      "contactNo": "1234567890",
      "source": "website",
      "positionInBoard": 1,
      "isConvertedClient": false
    }
  ]

✅ Success Response:

{
  "message": "Lead created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}

❗ Important Tips:

• Ensure "isConvertedClient": false is set in the request.

• Use the correct Role ID from Step 3.