Изменить CRM-форму crm.form.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом на изменение CRM-форм
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод crm.form.update частично изменяет CRM-форму: меняются только поля, переданные в fields.
Метод требует версию формы updatedTime из ответа crm.form.get. Если форму успели изменить, метод вернет ошибку CRM_FORM_VERSION_MISMATCH: получите форму заново и повторите запрос.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор формы. Идентификатор можно получить методом crm.form.list |
|
updatedTime* |
Версия формы — значение |
|
fields* |
Поля, которые нужно изменить. Формат полей такой же, как в ответе crm.form.get. Описание — в разделе Структура CRM-формы. Правила частичного изменения:
Поля, которые заполняет клиент, передаются в ключе Пустой объект |
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.form.update
Пример меняет заголовок формы, текст кнопки и сообщение после отправки. Остальные настройки формы не меняются.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":47,"updatedTime":"2026-10-21T17:44:00+03:00","fields":{"appearance":{"title":"Оставьте заявку","buttonCaption":"Отправить заявку"},"submission":{"success":{"text":"Спасибо! Мы перезвоним в течение часа."}}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":47,"updatedTime":"2026-10-21T17:44:00+03:00","fields":{"appearance":{"title":"Оставьте заявку","buttonCaption":"Отправить заявку"},"submission":{"success":{"text":"Спасибо! Мы перезвоним в течение часа."}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type FormUpdateResult = {
result: boolean
}
try {
const response = await $b24.actions.v3.call.make<FormUpdateResult>({
method: 'crm.form.update',
params: {
id: 47,
updatedTime: '2026-10-21T17:44:00+03:00',
fields: {
appearance: {
title: 'Оставьте заявку',
buttonCaption: 'Отправить заявку',
},
submission: {
success: {
text: 'Спасибо! Мы перезвоним в течение часа.',
},
},
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateForm() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'crm.form.update',
params: {
id: 47,
updatedTime: '2026-10-21T17:44:00+03:00',
fields: {
appearance: {
title: 'Оставьте заявку',
buttonCaption: 'Отправить заявку',
},
submission: {
success: {
text: 'Спасибо! Мы перезвоним в течение часа.',
},
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateForm)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
# client = Client(token, prefer_version=3)
try:
bitrix_response = client.crm.form.update(
id=47,
updatedTime="2026-10-21T17:44:00+03:00",
fields={
"appearance": {
"title": "Оставьте заявку",
"buttonCaption": "Отправить заявку",
},
"submission": {
"success": {
"text": "Спасибо! Мы перезвоним в течение часа.",
},
},
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'crm.form.update',
[
'id' => 47,
'updatedTime' => '2026-10-21T17:44:00+03:00',
'fields' => [
'appearance' => [
'title' => 'Оставьте заявку',
'buttonCaption' => 'Отправить заявку',
],
'submission' => [
'success' => [
'text' => 'Спасибо! Мы перезвоним в течение часа.',
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'crm.form.update',
{
id: 47,
updatedTime: '2026-10-21T17:44:00+03:00',
fields: {
appearance: {
title: 'Оставьте заявку',
buttonCaption: 'Отправить заявку',
},
submission: {
success: {
text: 'Спасибо! Мы перезвоним в течение часа.',
},
},
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'crm.form.update',
[
'id' => 47,
'updatedTime' => '2026-10-21T17:44:00+03:00',
'fields' => [
'appearance' => [
'title' => 'Оставьте заявку',
'buttonCaption' => 'Отправить заявку',
],
'submission' => [
'success' => [
'text' => 'Спасибо! Мы перезвоним в течение часа.',
],
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы, базовый адрес клиента содержит /rest/api/
res, err := client.Core().Call(ctx, "crm.form.update", b24.Params{
"id": 47,
"updatedTime": "2026-10-21T17:44:00+03:00",
"fields": map[string]any{
"appearance": map[string]any{
"title": "Оставьте заявку",
"buttonCaption": "Отправить заявку",
},
"submission": map[string]any{
"success": map[string]any{
"text": "Спасибо! Мы перезвоним в течение часа.",
},
},
},
})
if err != nil {
return fmt.Errorf("crm.form.update: %w", err)
}
var data struct {
Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &data); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(data.Result)
Обработка ответа
HTTP-статус: 200
{
"result": {
"result": true
},
"time": {
"start": 1792593882,
"finish": 1792593883.117865,
"duration": 1.1178650856018066,
"processing": 1,
"date_start": "2026-10-21T17:44:42+03:00",
"date_finish": "2026-10-21T17:44:43+03:00",
"operating_reset_at": 1792594440,
"operating": 0.9873239994049072
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит объект с ключом |
|
time |
Информация о времени выполнения запроса |
После изменения у формы новая версия updatedTime. Для следующего изменения получите ее методом crm.form.get.
Обработка ошибок
HTTP-статус: 409
{
"error": {
"code": "CRM_FORM_VERSION_MISMATCH",
"message": "Версия CRM-формы устарела, изменения не сохранены: получите форму заново и повторите запрос",
"currentUpdatedTime": "2026-10-21T17:44:00+03:00"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
HTTP-статус: 400
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте версию формы из ответа crm.form.get |
|
|
В поле |
Передайте дату в формате ISO 8601, например |
|
|
|
Меняйте активность методами crm.form.activate и crm.form.deactivate |
|
|
|
Не передавайте поля только для чтения |
|
|
crm.form.update changes one form addressed by id and takes no filter. |
Передайте идентификатор одной формы в |
|
|
A stored field can not be turned into a |
Не меняйте тип поля на |
|
|
Другие нарушения конфигурации |
Сообщения те же, что у crm.form.add. Проверьте изменения заранее методом crm.form.validate |
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
HTTP-статус: 400
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте только поля из раздела Структура CRM-формы |
Версия формы устарела
Код ошибки: CRM_FORM_VERSION_MISMATCH
HTTP-статус: 409
|
Поле |
Описание ошибки |
Как исправить |
|
|
Версия CRM-формы устарела, изменения не сохранены: получите форму заново и повторите запрос |
Получите форму методом crm.form.get, примените изменения к актуальной версии и повторите запрос. Текущая версия есть в ключе |
Системная форма
Код ошибки: CRM_FORM_SYSTEM_IMMUTABLE
HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Эту CRM-форму нельзя изменить или удалить |
Системную форму изменить нельзя. Проверьте поле |
Форма не найдена
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
HTTP-статус: 404
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Проверьте идентификатор методом crm.form.list |
Ограничения тарифа
Код ошибки: CRM_FORM_WRITE_RESTRICTED
HTTP-статус: 402
|
Поле |
Описание ошибки |
Как исправить |
|
|
На этом тарифе нельзя изменять CRM-формы |
Смените тариф Битрикс24 |
Ошибки доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте, что у пользователя есть право на изменение CRM-форм |
Код ошибки: CRM_FORM_PHONE_VERIFICATION_REQUIRED
HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Подтвердите номер телефона в Битрикс24, чтобы работать с CRM-формами |
Подтвердите номер телефона в Битрикс24 и повторите запрос |
Ошибка после сохранения
Код ошибки: CRM_FORM_SIDE_EFFECT_FAILED
HTTP-статус: 500
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удалось завершить действие, но данные CRM-формы уже изменены: проверьте состояние формы перед повторной попыткой |
Получите форму методом crm.form.get и проверьте ее состояние |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |