Изменить 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*
integer

Идентификатор формы.

Идентификатор можно получить методом crm.form.list

updatedTime*
string

Версия формы — значение updatedTime из ответа crm.form.get в формате ISO 8601, например 2026-10-21T17:44:00+03:00

fields*
object

Поля, которые нужно изменить. Формат полей такой же, как в ответе crm.form.get. Описание — в разделе Структура CRM-формы.

Правила частичного изменения:

  • переданное поле раздела меняет только это поле, например appearance.title
  • коллекции fields, dependencies, presetFields, responsible.userIds, agreements.items и другие заменяются целиком. Пустой массив очищает коллекцию
  • раздел нельзя очистить через null
  • поле active и поля только для чтения передавать нельзя. Активность меняют методы crm.form.activate и crm.form.deactivate

Поля, которые заполняет клиент, передаются в ключе fields внутри этого параметра. Свойства элемента name, type, label, required, multiple, placeholder, valueType, value описаны в структуре элемента fields.fields.

Пустой объект {} ничего не меняет, но проверяет, что форма существует и ее можно изменить

Примеры кода

Как использовать примеры в документации

Вызов нового 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
boolean

Корневой элемент ответа.

Содержит объект с ключом result и значением true, если форма изменена

time
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
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

HTTP-статус: 400

Поле

Описание ошибки

Как исправить

updatedTime

Обязательное поле updatedTime не указано

Передайте версию формы из ответа crm.form.get

updatedTime

В поле updatedTime требуется тип данных DateTime для такого запроса

Передайте дату в формате ISO 8601, например 2026-10-21T17:44:00+03:00

active

active is published for reading only

Меняйте активность методами crm.form.activate и crm.form.deactivate

booking

booking is published for reading only

Не передавайте поля только для чтения

filter

crm.form.update changes one form addressed by id and takes no filter.

Передайте идентификатор одной формы в id без filter

fields[N].type

A stored field can not be turned into a list one: the variants it offers are not part of this contract

Не меняйте тип поля на list, checkbox, radio, product, booking

-

Другие нарушения конфигурации

Сообщения те же, что у crm.form.add. Проверьте изменения заранее методом crm.form.validate

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

HTTP-статус: 400

Поле

Описание ошибки

Как исправить

fields

Неизвестное поле sort для сущности FormDto

Передайте только поля из раздела Структура CRM-формы

Версия формы устарела

Код ошибки: CRM_FORM_VERSION_MISMATCH

HTTP-статус: 409

Поле

Описание ошибки

Как исправить

updatedTime

Версия CRM-формы устарела, изменения не сохранены: получите форму заново и повторите запрос

Получите форму методом crm.form.get, примените изменения к актуальной версии и повторите запрос. Текущая версия есть в ключе currentUpdatedTime ответа

Системная форма

Код ошибки: CRM_FORM_SYSTEM_IMMUTABLE

HTTP-статус: 403

Поле

Описание ошибки

Как исправить

id

Эту CRM-форму нельзя изменить или удалить

Системную форму изменить нельзя. Проверьте поле system методом crm.form.get

Форма не найдена

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

HTTP-статус: 404

Поле

Описание ошибки

Как исправить

id

Запись с ID = #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, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение