Редактирование Лида

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

string

required

Идентификатор записи раздела "Лиды"

Body Params application/json

Раздел, в котором менеджер ведет учет взаимодействия с лидами. Создание новых лидов должно быть возможно как через форму создания так и через загрузку Excel документа. В качестве шаблона для загрузки должна выгружаться пустая таблица со полями создаваемой сущности.

leadSource

string <uri-reference>

required

Название Источника лида

Example:

/lead-sources/1

name

string

optional

Персональные данные лида

surname

string

optional

Персональные данные лида

company

string

optional

Персональные данные лида

campaign

string

optional

Рекламная кампания

phone

string

optional

Номер телефона

Match pattern:

^((\+7|7|8)+([0-9]){10})$

string <email>

optional

Электронная почта

city

string

optional

Название города

leadStatus

string <iri-reference>

required

Название статуса

Example:

/lead-statuses/1

additionalInformation

string

optional

Доп информация

manager

string <iri-reference>

required

Менеджер (Имя и фамилия сотрудника)

Example:

/users/1

recommendedCustomer

string <iri-reference>

optional

Рекомендация от клиента (Имя, фамилия, компания клиента)

Example:

/customers/1

service

string <iri-reference>

required

Название услуги

Example:

/services/1

customer

string <iri-reference>

optional

Клиент (Имя, фамилия и компания клиента)

Example:

/customers/1

labelUtm

string

optional

Связанная с клиентом utm-метка

causeFailure

string <iri-reference>

optional

Наименование причины отказа

Example:

/cause-failures/1

Example

{
    "leadSource": "/lead-sources/1",
    "name": "string",
    "surname": "string",
    "company": "string",
    "campaign": "string",
    "phone": "string",
    "email": "user@example.com",
    "city": "string",
    "leadStatus": "/lead-statuses/1",
    "additionalInformation": "string",
    "manager": "/users/1",
    "recommendedCustomer": "/customers/1",
    "service": "/services/1",
    "customer": "/customers/1",
    "labelUtm": "string",
    "causeFailure": "/cause-failures/1"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

integer

required

>= 1

leadSource

object (Источники лидов)

required

Название Источника лида

deletedAt

string <date-time> | null

required

integer

required

>= 1

title

string

required

Название источника

purpose

object

Enum

required

utmMarks

array[object (UTM-метки) {5}]

optional

Обязательно, если в назначении выбрано UTM метка.
Перечень utm-меток. Заполняется только при условии если в назначении выбрано UTM метка.

name

string

optional

Персональные данные лида

surname

string

optional

Персональные данные лида

company

string

optional

Персональные данные лида

campaign

string

optional

Рекламная кампания

phone

string

optional

Номер телефона

Match pattern:

^((\+7|7|8)+([0-9]){10})$

string <email>

optional

Электронная почта

city

string

optional

Название города

leadStatus

object (Enum)

required

Название статуса

integer

required

>= 1

label

string

required

additionalInformation

string

optional

Доп информация

manager

object (Пользователи)

required

Менеджер (Имя и фамилия сотрудника)

recommendedCustomer

allOf {2}

optional

Рекомендация от клиента (Имя, фамилия, компания клиента)

object (BaseFieldsModel)

optional

object

optional

service

object (Услуги)

required

Название услуги

customer

allOf {2}

optional

Клиент (Имя, фамилия и компания клиента)

labelUtm

string

optional

Связанная с клиентом utm-метка

causeFailure

object (Причины отказов)

optional

Наименование причины отказа

deletedAt

string <date-time> | null

required

integer

required

>= 1

title

string

required

Причина отказа

lastTodo

allOf {2}

optional

Крайнее дело

additionalPhone

string | null

Добавочный номер

optional

Добавочный номер телефона Лида

Example

🟠400Ошибки 4XX

🔴500Ошибки 5XX