CRM leads

Изменить лид

Изменяет указанный лид CRM.

patch/api/v1/crm/leads/{id}

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/crm/leads/{id}
  • 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)

Request body

titlestring
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
clear_customerboolean

Отвязать клиента от лида. Пустой crm_customer_id значит «не менять», поэтому отвязка — этим признаком

next_actionstring
next_action_atstring date-time nullable
archivedboolean
customobject nullable

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

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.