CRM leads

Создать лид

Создаёт лид CRM. Читает Idempotency-Key — повтор того же запроса с тем же ключом отдаёт созданный лид, а не второй.

post/api/v1/crm/leads

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/crm/leads
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Headers

X-Tenantstring required

Slug выбранного кабинета; кабинет не является юрлицом

Idempotency-Keystring

Ключ одной логической попытки команды. Единственная форма идемпотентности на уровне HTTP; читают его только операции, у которых этот параметр объявлен.

Повтор ТОГО ЖЕ запроса (метод, адрес с параметрами, тело) с тем же ключом не выполняет команду второй раз, а отдаёт первый успешный ответ с заголовком Idempotent-Replay: true. Тот же ключ с другим запросом — отказ 422 idempotency.key_mismatch, а не чужой ответ. Пока первая попытка ещё выполняется, повтор получает 409 idempotency.in_progress и Retry-After: он не ждёт и не выполняется второй раз.

Ключ принадлежит предъявителю в кабинете: человеку, кабинетному API-ключу или установке приложения. Одинаковый ключ у соседа — другая попытка.

Отказ 4xx ключ ОСВОБОЖДАЕТ: запрос отклонён до работы, в кабинете не изменилось ничего, и исправленный запрос с тем же ключом выполняется. Отказ 5xx ключ ЗАПИРАЕТ: записалось или нет — неизвестно, коммит мог случиться, а ответ до вас не доехать. Повтор с тем же ключом получает тот же статус и тот же машинный код, а команда второй раз не выполняется. Чтобы попробовать снова, прочитайте отдельным запросом, появился ли результат, и возьмите НОВЫЙ ключ.

И ответ, и запомненный отказ живут сутки; после этого тот же ключ — новая попытка, и команда выполняется заново. Ответы, несущие секрет (выдача токена, аренда секрета настройки), заголовок не читают: секрет отдаётся ровно один раз. Хранилище недоступно — 503 idempotency.unavailable, команда без защиты не выполняется; этот отказ приходит ДО заявки на ключ и потому ключ не тратит.

Для естественного ключа интеграции годится любая строка вида crm:order:123:create; UUID не обязателен.

Request body

titlestring required
amountstring

Сумма лида десятичной строкой: «19990.50». Разрядность берёт валюта (MONEY-ROUNDING.md)

currencystring

Обязателен при ненулевой сумме

sourcestring
descriptionstring
first_messagestring
contact_handlestring
reference_idstring uuid nullable
owner_idinteger nullable
customer_idstring uuid nullable

Прежний вход: контрагент справочника ERP. Сервер находит или заводит по нему клиента CRM и записывает crm_customer_id; в ответе поля нет.

crm_customer_idstring uuid nullable
next_actionstring
next_action_atstring date-time nullable
customobject nullable

Дополнительные поля кабинета: состав задаёт «Настройки → Поля»

utm_sourcestring
utm_mediumstring
utm_campaignstring
utm_termstring
utm_contentstring
landing_pagestring
referrerstring

Response

Созданный лид

idstring uuid required
titlestring required
amountstring

Сумма лида десятичной строкой: «19990.50»; переходит в сделку при конвертации

currencystring

Код валюты из справочника ERP; пусто — валюта не выбрана

sourcestring required

Канал обращения; по нему собирается аналитика источников

descriptionstring required

Заметка менеджера о заявке

first_messagestring required

Что написал или сказал клиент - слова самого обращения, а не пересказ

contact_handlestring required

Ник, номер или адрес в канале, пока карточка клиента не заведена

reference_idstring uuid
owner_idinteger
stage_idstring uuid
crm_customer_idstring uuid
next_actionstring required
next_action_atstring date-time
archived_atstring date-time
status'new' | 'qualified' | 'disqualified' | 'converted' required

Единственный статус лида. Вычисляется из смысла этапа лида (CRMLeadStageMeaning) и напрямую не правится: меняется переносом на этап, квалификацией, отказом или конвертацией

qualification_reasonstring
reject_reason_idstring uuid
converted_deal_idstring uuid
merged_into_lead_idstring uuid
utm_sourcestring
utm_mediumstring
utm_campaignstring
utm_termstring
utm_contentstring
landing_pagestring
referrerstring
customobject nullable

Дополнительные поля кабинета: состав задаёт «Настройки → Поля»

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.