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

Выключить форму

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

Выключает CRM-форму по идентификатору и сохраняет её настройки, поэтому выключенную форму можно включить снова.

Параметры

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

Параметров строки запроса у метода нет: любой такой параметр возвращает 400 INVALID_PARAMS.

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

Тело можно не передавать или передать пустой объект {}. Любое поле, кроме updatedTime, возвращает 400 INVALID_PARAMS.

Поле Тип Обяз. Описание
ПолеupdatedTime Типstring Обяз.нет ОписаниеВремя последнего изменения формы из GET /v1/crm-forms/:id. Если форму изменили позже этого времени, выключение отклоняется с 409 CRM_FORM_VERSION_MISMATCH. Без поля проверка версии не выполняется

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-forms/75/deactivate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-forms/75/deactivate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/75/deactivate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const { data } = await res.json()
console.log(data.active, data.updatedTime)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/75/deactivate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
const { data } = await res.json()
console.log(data.active, data.updatedTime)

Тип и значение updatedTime проверяет Битрикс24.

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успешном выключении
Полеdata.active Типboolean ОписаниеСостояние формы после вызова
Полеdata.updatedTime Типstring ОписаниеВремя последнего изменения формы после выключения, ISO 8601 со смещением часового пояса. Передаётся в следующий запрос записи

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

JSON 
{
  "success": true,
  "data": {
    "active": false,
    "updatedTime": "2026-11-05T11:25:34+03:00"
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "b24Code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
    "message": "Запись с ID = `99999999` не найдена"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не положительное целое число, передан параметр строки запроса, тело не JSON-объект, в теле есть поле кроме updatedTime
HTTP402 КодCRM_FORM_WRITE_RESTRICTED ОписаниеТариф Битрикс24 не разрешает запись CRM-форм. На бесплатном и демо-тарифе запись не выполняется
HTTP403 КодCRM_FORM_SYSTEM_IMMUTABLE ОписаниеФорма системная — system: true в списке форм. Системную форму выключить нельзя
HTTP404 КодENTITY_NOT_FOUND ОписаниеФормы с таким id нет
HTTP409 КодCRM_FORM_VERSION_MISMATCH ОписаниеФорму изменили после переданного updatedTime. Текущее время изменения — в error.currentUpdatedTime
HTTP403 КодBITRIX_INSUFFICIENT_SCOPE ОписаниеУ токена Битрикс24 нет необходимого скоупа
HTTP409 КодCRM_FORM_REST_NOT_ENABLED ОписаниеНа портале выключены методы CRM-форм
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеБитрикс24 отказал пользователю ключа в доступе к форме
HTTP422 КодBITRIX_ERROR ОписаниеДругой отказ Битрикс24. Текст отказа — в error.message
HTTP500 КодCRM_FORM_SIDE_EFFECT_FAILED ОписаниеИзменение уже сохранено, но завершилось с ошибкой. Перечитайте форму через GET /v1/crm-forms/:id до повтора
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен или вернул ответ неожиданной формы. Перечитайте форму до повтора
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч только для чтения
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа crm
HTTP401 КодMISSING_API_KEY ОписаниеНе передан X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет действующей авторизации в Битрикс24

Ошибки портала содержат исходный код в error.b24Code и ошибки полей в error.validation, если они переданы. Коды CRM_FORM_* сохраняют HTTP-статус, код и сообщение. Ответы 429 и 503 описаны в разделе Лимиты и оптимизация. Полный список общих ошибок API — Ошибки.

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

  • Повторный вызов не возвращает ошибку. Выключение уже выключенной формы отвечает 200 с active: false, и updatedTime при этом не меняется.

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