Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-forms/results.md индекс документации — /llms.txt

Отправить данные посетителя

POST /v1/crm-forms/:id/results

Отправляет значения полей CRM-формы от имени посетителя, как при заполнении формы на сайте. Результат обрабатывается по настройкам формы: по нему может быть создан лид или сделка, запущена автоматизация и отправлены уведомления ответственным.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типinteger Обяз.да ОписаниеИдентификатор формы. Список: Список форм

Поля запроса (body)

Поле Тип Обяз. Описание
Полеfields Типobject Обяз.да ОписаниеНепустой объект значений. Ключи — имена полей формы fields[].name из Получить форму, например LEAD_NAME, LEAD_PHONE. Поля типа file не поддерживаются
Полеpresets Типobject Обяз.нет ОписаниеПредустановленные значения, передаются без изменений
ПолеfromUrl Типstring Обяз.нет ОписаниеАдрес страницы, на которой заполнена форма

Другие поля в теле не принимаются. Состав и значения полей проверяются по настройкам формы.

Примеры

curl — личный ключ

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-forms/75/results" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fields":{"LEAD_NAME":"Анна","LEAD_PHONE":"+12025550123"},"fromUrl":"https://example.com/contact"}'

curl — OAuth-приложение

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-forms/75/results" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fields":{"LEAD_NAME":"Анна","LEAD_PHONE":"+12025550123"},"fromUrl":"https://example.com/contact"}'

JavaScript — личный ключ

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/75/results', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: { LEAD_NAME: 'Анна', LEAD_PHONE: '+12025550123' },
    fromUrl: 'https://example.com/contact',
  }),
})

const { data } = await res.json()
console.log('Результат формы:', data.resultId)

JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/75/results', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: { LEAD_NAME: 'Анна', LEAD_PHONE: '+12025550123' },
    fromUrl: 'https://example.com/contact',
  }),
})

const { data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue, когда результат сохранён
Полеdata.resultId Типnumber ОписаниеИдентификатор результата заполнения формы. Это не ID созданного лида или сделки

Пример ответа

HTTP 201 — результат сохранён:

JSON
{
  "success": true,
  "data": {
    "resultId": 231
  }
}

Пример ответа при ошибке

404 — формы с таким id нет:

JSON
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Form not found."
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодMISSING_REQUIRED_FIELDS Описаниеfields не передан, пуст или не объект, сообщение «fields must be a non-empty object»
HTTP400 КодINVALID_PARAMS Описаниеid не положительное целое число, сообщение «id must be a positive safe integer»
HTTP400 КодINVALID_PARAMS ОписаниеТело не JSON-объект, сообщение «Request body must be a JSON object»
HTTP400 КодINVALID_PARAMS ОписаниеВ теле есть поле, кроме fields, presets, fromUrl, сообщение «Only fields, presets and fromUrl are accepted»
HTTP400 КодINVALID_PARAMS Описаниеpresets не объект или fromUrl не строка
HTTP404 КодENTITY_NOT_FOUND ОписаниеФормы с таким id нет, сообщение «Form not found.»
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 не принял результат: форма выключена («Form is not active.») или передано поле типа file. Текст Битрикс24 приходит в message, исходный код — в b24Code, для выключенной формы ERROR_CORE
HTTP403 Кодкод Битрикс24 ОписаниеБитрикс24 отказал в доступе. code и message приходят от Битрикс24 без изменений
HTTP409 Кодкод Битрикс24 ОписаниеБитрикс24 отклонил результат из-за состояния формы или портала. code и message приходят от Битрикс24 без изменений
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч только для чтения. Для отправки нужен ключ с правом записи
HTTP429 КодRATE_LIMITED ОписаниеПревышена частота запросов к Битрикс24
HTTP502 КодBITRIX_RESPONSE_INVALID ОписаниеБитрикс24 не вернул идентификатор результата, сообщение Bitrix24 returned no result ID; do not retry blindly
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен: ответил ошибкой сервера или соединение оборвалось
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 принял запрос, но не ответил за отведённое время
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ API-ключа нет настроенных токенов Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ API-ключа нет скоупа crm

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Не повторяйте отправку вслепую. Каждый вызов сохраняет новый результат, и Вайбкод сам отправку не повторяет. После 502, 503 или обрыва соединения результат мог сохраниться и уже запустить автоматизацию, поэтому повторный вызов создаст второй результат.
  • Неизвестные ключи fields не отклоняются. Значение с именем, которого нет в форме, не вызывает ошибку: результат создаётся и возвращается 201. Сверяйте ключи с fields[].name формы до отправки.

Смотрите также