CRM leads

Завершить загрузку документа согласия

Проверяет, что файл лёг по выданному адресу: размер, контрольную сумму (если заявлена) и антивирус. Затем ставит его документом согласия формы; прежний файл удаляется. Повтор возвращает ту же форму. 409 transfer.not_uploaded — байтов ещё нет; 422 transfer.infected — найдена угроза, файл удалён; 503 transfer.scanner_unavailable — повторите позже.

post/api/v1/crm/web-form-upload-sessions/{id}/finish

Request

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

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 2 revisions of this API.