CRM leads

Создать форму заявок для сайта

Заводит форму заявок. Заявка формы всегда находит клиента CRM — человека по телефону, затем по почте; компанию по ИНН, затем по названию, и её контактное лицо (client_kind) — или заводит нового, и создаёт лид (target=lead) или сделку (target=deal) на открытом этапе выбранной воронки. Нужно хотя бы одно поле связи — телефон или почта (422 crm.web_form_contact). Отказы проверки — 422 crm.web_form_name, crm.web_form_target, crm.web_form_stage, crm.web_form_fields, crm.web_form_client_kind, crm.web_form_company_field, crm.web_form_origin_invalid, crm.web_form_text; повтор названия — 409 crm.web_form_name_used.

post/api/v1/crm/web-forms

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/crm/web-forms
  • Auth: one of:
    • HTTP bearer
    • 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 выбранного кабинета; кабинет не является юрлицом

Request body

namestring required

Название формы; уникально в кабинете

is_activeboolean
target'lead' | 'deal'
client_kind'person' | 'company' | 'choice'

Кто оставляет заявку. У компании и выбора нужно поле company, иначе 422 crm.web_form_company_field; неизвестное значение — 422 crm.web_form_client_kind. У частного лица поля company и inn убираются

contact_labelstring

Подпись поля имени, когда заявку оставляет компания («Контактное лицо»); пусто — подпись поля как есть

pipeline_idstring uuid nullable

Обязательна при target=deal

stage_idstring uuid nullable

Открытый действующий этап воронки; обязателен при target=deal

sourcestring
owner_idinteger nullable
titlestring
button_textstring
success_messagestring
consent_requiredboolean
consent_textstring
consent_urlstring

Ссылка на документ согласия (https://site.ru/policy); неверная — 422 crm.web_form_consent_url

consent_link_textstring

Слова ссылки на документ

allowed_originsstring[]

Сайты формы; адрес приводится к виду https://site.ru

Response

Созданная форма

idstring uuid required
namestring required
is_activeboolean required

Выключенная форма заявок не принимает

target'lead' | 'deal' required

Что создаёт заявка: лид или сделку

client_kind'person' | 'company' | 'choice' required

Кто оставляет заявку: person — частное лицо (клиент-человек по телефону, затем почте, или новый); company — компания (по ИНН, без ИНН — по названию, или новая) и её контактное лицо, связанное с ней, лид или сделка — на компании; choice — посетитель выбирает на форме

contact_labelstring required

Подпись поля имени, когда заявку оставляет компания («Контактное лицо»); пусто — подпись поля как есть

pipeline_idstring uuid nullable required

Воронка сделки; пусто у лида. Воронку удалили — заявки идут лидами

stage_idstring uuid nullable required

Открытый этап, на который встаёт сделка заявки

sourcestring required

Код источника из справочника источников обращения: им помечается лид или сделка

owner_idinteger nullable required

Ответственный заявок; пусто — создатель формы

titlestring required

Заголовок над формой

button_textstring required
success_messagestring required

Что увидит посетитель после отправки

consent_requiredboolean required

Спрашивать согласие на обработку персональных данных

consent_textstring required
consent_urlstring required

Ссылка на документ согласия на сайте клиента; прикреплённый файл главнее

consent_link_textstring required

Слова ссылки на документ рядом с галочкой согласия

allowed_originsstring[] required

Сайты, с которых принимаются заявки (https://site.ru); пусто — любой сайт

created_byinteger required
created_atstring date-time required
updated_atstring date-time required
public_keystring required

Ключ публичного адреса: /api/v1/crm/public/forms/{public_key}. Не секрет — он стоит в коде сайта

last_submitted_atstring date-time nullable required

Когда форма последний раз создала лид или сделку

submissions_24hinteger required

Сколько лидов и сделок форма создала за сутки

Changes

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