Перейти к основному содержанию
Конечная точка «Создание клиента» позволяет добавлять клиентов непосредственно в ваше рабочее пространство AgencyHandy из внешней системы. В отличие от лидов, клиенты — это полностью подключённые контакты, которых можно назначать к заказам, счетам и проектам. Используйте эту конечную точку для синхронизации новых клиентов из CRM-системы, формы регистрации или любого другого источника данных.
Перед использованием этой конечной точки выполните руководство Начало работы для получения API-ключа и идентификатора компании. В отличие от конечной точки «Создание лида», создание клиента не требует отдельного шага для получения идентификатора роли.

​
Предварительные требования

  • ✅ API-ключ, сгенерированный в разделе Настройки рабочего пространства → API-ключ
  • ✅ Идентификатор компании, полученный из GET {{URL}}/accounts/companies

​
Конечная точка

POST {{URL}}/members/bulk-client

​
Заголовки

ЗаголовокЗначение
x-api-keyВаш API-ключ
companyIdВаш идентификатор компании
Content-Typeapplication/json

​
Тело запроса

Тело запроса представляет собой массив JSON. Вы можете создать одного или нескольких клиентов в одном запросе.
​
firstName
string
обязательно
Имя клиента.
​
lastName
string
обязательно
Фамилия клиента.
​
email
string
обязательно
Адрес электронной почты клиента. Должен быть уникальным в пределах вашего рабочего пространства.
​
isConvertedClient
boolean
обязательно
Установите false для совершенно нового клиента. Установите true при конвертации существующего лида в клиента.
​
status
string
Статус клиента. Распространённые значения: New, Active. По умолчанию используется New, если не указано.
​
contactNo
string
Номер телефона клиента.
​
source
string
Источник привлечения клиента. Примеры значений: website, referral, social.
​
positionInBoard
number
Позиция клиента в столбце доски. По умолчанию 1.

​
Пример запроса

cURL
curl --request POST "https://api.agencyhandy.com/members/bulk-client" \
  --header "x-api-key: <YOUR_API_KEY>" \
  --header "companyId: <YOUR_COMPANY_ID>" \
  --header "Content-Type: application/json" \
  --data '[
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "isConvertedClient": false,
      "status": "New",
      "contactNo": "1234567890",
      "source": "website",
      "positionInBoard": 1
    }
  ]'

​
Успешный ответ

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Строка подтверждения при успешном выполнении.
​
createdMembers
array
Массив созданных объектов клиентов.
​
createdMembers[].\_id
string
Уникальный идентификатор вновь созданного клиента. Используйте этот идентификатор при назначении клиента к заказам или счетам через API.
​
createdMembers[].name
string
Полное имя клиента (firstName + lastName).
​
createdMembers[].status
string
Статус клиента в том виде, как он сохранён.
​
createdMembers[].role
string
Роль, назначенная участнику — будет "client".
Заголовок companyId для этой конечной точки использует заглавную букву I в Id — companyId — в отличие от некоторых других конечных точек, которые используют companyid (все строчные). Используйте точное написание, указанное выше, во избежание ошибок аутентификации.
Передайте несколько объектов клиентов в массиве для массового создания клиентов в одном API-вызове. Каждый объект должен иметь уникальный адрес email. Дублирующиеся адреса электронной почты вызовут ошибку валидации для соответствующей записи.