👨‍🔬Create a New Client

API usage example for creating a Client 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: Create a New Client

📍 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]",
      "isConvertedClient": false,
      "status": "New",
      "contactNo": "1234567890",
      "source": "website",
      "positionInBoard": 1
    }
]

✅ Success Response:

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