QUINCEFIN
Відкрити меню

QUINCE API. Ліди

Список методів

МетодОпис
/api/v2/crm/lead/listОтримання списку лідів
/api/v2/crm/lead/loadОтримання одного ліда за Id
/api/v2/crm/lead/addСтворення лідів
/api/v2/crm/lead/updateОновлення лідів

Отримання списку лідів

Назва методу: /api/v2/crm/lead/list

Повертає список CRM-лідів. Для навігації використовується номер сторінки page. Якщо розмір сторінки не перевизначений системними налаштуваннями, API повертає до 100 елементів.

Параметри запиту

ПолеТипОпис
filterobjectФільтр лідів. Поля фільтра працюють з логікою AND.
filter.IdintegerІдентифікатор ліда.
filter.NamestringПошук за назвою ліда. Пошук виконується як входження рядка без урахування регістру.
filter.PartnerintegerІдентифікатор партнера.
filter.ResponsibleintegerІдентифікатор відповідального користувача.
filter.SalesFunnelintegerІдентифікатор воронки продажів.
filter.SalesFunnelStageintegerІдентифікатор етапу воронки продажів.
filter.ArchivebooleanОзнака повернення архівних лідів. Передається в API як Void.
filter.MobileAppbooleanЯкщо true, API використовує збільшений ліміт вибірки.
pageintegerНомер сторінки. Якщо не передати, використовується перша сторінка.

Основні поля відповіді

ПолеОпис
IdІдентифікатор ліда.
DateДата ліда.
NameНазва ліда.
DescriptionОпис.
InformationSourceІдентифікатор джерела інформації.
InformationSourceNameНазва джерела інформації.
InformationSourceDetailДеталізація джерела інформації.
ResponsibleІдентифікатор відповідального користувача.
ResponsibleNameІм’я відповідального користувача.
InitialPersonNameПочаткове ім’я контактної особи.
InitialPositionПочаткова посада контактної особи.
InitialPartnerNameПочаткова назва компанії або партнера.
InitialPhoneПочатковий телефон.
InitialEmailПочатковий email.
InitialWebsiteПочатковий сайт.
InitialAddressПочаткова адреса.
InitialInstagramПочатковий Instagram.
PartnerІдентифікатор партнера.
PartnerNameНазва партнера.
SalesFunnelІдентифікатор воронки продажів.
SalesFunnelNameНазва воронки продажів.
SalesFunnelStageІдентифікатор етапу воронки.
SalesFunnelStageNameНазва етапу воронки.
StatusReasonІдентифікатор причини статусу.
StatusReasonNameНазва причини статусу.
SumОчікувана сума.
CurrencyІдентифікатор валюти.
CurrencyCodeКод валюти.
VoidОзнака архівного запису.
DateCreatedДата створення.
DateModifiedДата останнього редагування.
LeadPersonsКонтактні особи ліда.

Поля контактних осіб LeadPersons

ПолеОпис
IdІдентифікатор зв’язку.
PersonІдентифікатор контактної особи.
PersonNameІм’я контактної особи.
IsPrimaryОзнака основної контактної особи.

Приклад запиту

{
  "filter": {
    "Name": "demo",
    "SalesFunnel": 12,
    "Archive": false
  },
  "page": 1
}

Отримання одного ліда

Назва методу: /api/v2/crm/lead/load

Повертає один лід за Id. Ідентифікатор можна передати напряму в тілі запиту або в filter.Id.

Приклад запиту

{
  "Id": 12345
}

Якщо Id не передати, API поверне помилку Execution terminated. "Id" is required.

Створення та оновлення лідів

Назва методу створення: /api/v2/crm/lead/add

Назва методу оновлення: /api/v2/crm/lead/update

Методи додають або оновлюють ліди пакетами. Якщо системний ліміт пакета не перевизначений, максимальний розмір пакета - 100 елементів.

Параметри запиту

ПолеТипОпис
arrayarrayМасив лідів. Обов’язковий.
array[].IdintegerІдентифікатор ліда. Обов’язковий для /api/v2/crm/lead/update.
array[].DatestringДата ліда. Якщо не передати, використовується поточна дата сервера.
array[].NamestringНазва ліда. Обов’язкова для створення та оновлення.
array[].DescriptionstringОпис.
array[].InformationSourceintegerІдентифікатор джерела інформації. Якщо не передати, використовується джерело за замовчуванням.
array[].InformationSourceDetailstringДеталізація джерела інформації.
array[].ResponsibleintegerІдентифікатор відповідального. Якщо не передати, використовується поточний API-користувач.
array[].InitialPersonNamestringПочаткове ім’я контактної особи.
array[].InitialPositionstringПочаткова посада.
array[].InitialPartnerNamestringПочаткова назва компанії або партнера.
array[].InitialPhonestringПочатковий телефон.
array[].InitialEmailstringПочатковий email.
array[].InitialWebsitestringПочатковий сайт.
array[].InitialAddressstringПочаткова адреса.
array[].InitialInstagramstringПочатковий Instagram.
array[].PartnerintegerІдентифікатор партнера.
array[].SalesFunnelintegerІдентифікатор воронки продажів. Якщо не передати, використовується воронка для лідів за замовчуванням.
array[].SalesFunnelStageintegerІдентифікатор етапу воронки. Якщо не передати, використовується перший доступний етап воронки.
array[].StatusReasonintegerІдентифікатор причини статусу.
array[].SumnumberОчікувана сума.
array[].CurrencyintegerІдентифікатор валюти.
array[].VoidbooleanОзнака архівного запису.
array[].LeadPersonsarrayКонтактні особи ліда. Також підтримується назва Persons.

Поля контактних осіб під час запису

ПолеОпис
LeadPersons[].PersonІдентифікатор контактної особи.
LeadPersons[].IdАльтернативне поле для ідентифікатора контактної особи, якщо Person не передано.
LeadPersons[].IsPrimaryОзнака основної контактної особи.

Якщо передати LeadPersons або Persons, API синхронізує список контактних осіб для ліда. Для одного ліда основною залишиться тільки одна контактна особа.

Приклад створення

{
  "array": [
    {
      "Name": "Запит з сайту",
      "InitialPersonName": "Іван Петренко",
      "InitialPhone": "+380501112233",
      "InitialEmail": "[email protected]",
      "Sum": 25000,
      "Currency": 980,
      "LeadPersons": [
        {
          "Person": 456,
          "IsPrimary": true
        }
      ]
    }
  ]
}

Приклад оновлення

{
  "array": [
    {
      "Id": 12345,
      "Name": "Запит з сайту",
      "SalesFunnelStage": 34,
      "Responsible": 7
    }
  ]
}

Формат відповіді для add і update

ПолеОпис
successОзнака успішного виконання.
data[].IdІдентифікатор створеного або оновленого ліда.
data[].TempIdТимчасовий номер елемента в пакеті, який дає змогу зіставити відповідь із запитом.

Якщо array не передати або передати не масив, API поверне success: false і текст помилки Not valid format or empty array.