Изменить настройки размещения CRM-формы crm.form.embedding.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом на изменение CRM-форм

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.form.embedding.update сохраняет настройки показа CRM-формы по клику и автопоказа.

Метод меняет версию формы updatedTime. Перед следующим изменением формы или ее размещения получите новую версию методом crm.form.get.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

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

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

updatedTime*
datetime

Версия формы — дата последнего изменения в формате ISO 8601, например 2026-10-21T17:48:29+03:00.

Значение можно получить методом crm.form.get из поля updatedTime. Если форму изменили после того, как вы получили значение, метод вернет ошибку CRM_FORM_VERSION_MISMATCH

fields*
object

Настройки, которые нужно изменить. Непереданные настройки остаются без изменений, чтобы сбросить настройку, передайте для нее null. Пустой объект {} допустим: в этом случае метод ничего не меняет, подробное описание

Параметр fields

Структура fields повторяет структуру ответа crm.form.embedding.get: настройки варианта передаются в объекте settings внутри click или auto. Другие поля ответа изменить нельзя, у варианта inline настроек нет.

Название
тип

Описание

click.settings
object

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

auto.settings
object

Настройки автопоказа формы, подробное описание

Объект click.settings

Допустимые значения type, position, vertical, button.font и button.align возвращает метод crm.form.embedding.get в объекте click.options.

Название
тип

Описание

type
string

Вид окна формы.

Возможные значения:

  • popup — всплывающее окно
  • panel — боковая панель

position
string

Положение окна по горизонтали.

Возможные значения:

  • left — слева
  • center — по центру
  • right — справа

vertical
string

Положение окна по вертикали.

Возможные значения:

  • bottom — снизу
  • top — сверху

button
object

Настройки кнопки, подробное описание

Объект click.settings.button

Название
тип

Описание

use
boolean

Показывать ли кнопку Битрикс24 на сайте.

Возможные значения:

  • true — показывать кнопку с настройками из этого объекта
  • false — не показывать кнопку

text
string

Текст кнопки, не длиннее 255 символов

font
string

Шрифт кнопки.

Возможные значения:

  • modern
  • classic
  • elegant

align
string

Выравнивание кнопки.

Возможные значения:

  • inline — в строку с текстом
  • left — по левому краю
  • center — по центру
  • right — по правому краю

plain
boolean

Кнопка без фона.

Возможные значения:

  • true — кнопка без фона
  • false — кнопка с фоном

rounded
boolean

Скругленные углы кнопки.

Возможные значения:

  • true — углы скруглены
  • false — углы прямые

outlined
boolean

Обводка кнопки.

Возможные значения:

  • true — у кнопки есть обводка
  • false — обводки нет

decoration
string

Подчеркивание текста кнопки, не длиннее 20 символов. В интерфейсе используются значения dotted и solid

color
object

Цвета кнопки в формате HEX: #3bc8f5 или с прозрачностью #3eddffa6. Допустимы 3, 4, 6 или 8 шестнадцатеричных цифр после #:

  • text — цвет текста
  • textHover — цвет текста при наведении
  • background — цвет фона
  • backgroundHover — цвет фона при наведении

Объект auto.settings

Допустимые значения возвращает метод crm.form.embedding.get в объекте auto.options.

Название
тип

Описание

type
string

Вид окна формы: popup или panel

position
string

Положение окна по горизонтали: left, center или right

vertical
string

Положение окна по вертикали: bottom или top

delay
integer

Задержка автопоказа в секундах.

Возможные значения: 3, 5, 7, 10, 15, 20, 25, 30, 40, 60, 120

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.form.embedding.update

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":49,"updatedTime":"2026-10-21T17:48:29+03:00","fields":{"click":{"settings":{"type":"popup","position":"left","vertical":"bottom","button":{"use":true,"text":"Оставить заявку","font":"modern","align":"right","rounded":true,"color":{"text":"#ffffff","background":"#3bc8f5"}}}},"auto":{"settings":{"type":"panel","delay":10}}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.embedding.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":49,"updatedTime":"2026-10-21T17:48:29+03:00","fields":{"click":{"settings":{"type":"popup","position":"left","vertical":"bottom","button":{"use":true,"text":"Оставить заявку","font":"modern","align":"right","rounded":true,"color":{"text":"#ffffff","background":"#3bc8f5"}}}},"auto":{"settings":{"type":"panel","delay":10}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.embedding.update
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FormEmbeddingUpdateResult = {
  result: boolean
}

try {
  const response = await $b24.actions.v3.call.make<FormEmbeddingUpdateResult>({
    method: 'crm.form.embedding.update',
    params: {
      id: 49,
      updatedTime: '2026-10-21T17:48:29+03:00',
      fields: {
        click: {
          settings: {
            type: 'popup',
            position: 'left',
            vertical: 'bottom',
            button: {
              use: true,
              text: 'Оставить заявку',
              font: 'modern',
              align: 'right',
              rounded: true,
              color: {
                text: '#ffffff',
                background: '#3bc8f5',
              },
            },
          },
        },
        auto: {
          settings: {
            type: 'panel',
            delay: 10,
          },
        },
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  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)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateFormEmbedding() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'crm.form.embedding.update',
        params: {
          id: 49,
          updatedTime: '2026-10-21T17:48:29+03:00',
          fields: {
            click: {
              settings: {
                type: 'popup',
                position: 'left',
                vertical: 'bottom',
                button: {
                  use: true,
                  text: 'Оставить заявку',
                  font: 'modern',
                  align: 'right',
                  rounded: true,
                  color: {
                    text: '#ffffff',
                    background: '#3bc8f5',
                  },
                },
              },
            },
            auto: {
              settings: {
                type: 'panel',
                delay: 10,
              },
            },
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      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', updateFormEmbedding)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "click": {
        "settings": {
            "type": "popup",
            "position": "left",
            "vertical": "bottom",
            "button": {
                "use": True,
                "text": "Оставить заявку",
                "font": "modern",
                "align": "right",
                "rounded": True,
                "color": {
                    "text": "#ffffff",
                    "background": "#3bc8f5",
                },
            },
        },
    },
    "auto": {
        "settings": {
            "type": "panel",
            "delay": 10,
        },
    },
}

try:
    bitrix_response = client.crm.form.embedding.update(
        id=49,
        updatedTime="2026-10-21T17:48:29+03:00",
        fields=fields,
    ).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.embedding.update',
            [
                'id' => 49,
                'updatedTime' => '2026-10-21T17:48:29+03:00',
                'fields' => [
                    'click' => [
                        'settings' => [
                            'type' => 'popup',
                            'position' => 'left',
                            'vertical' => 'bottom',
                            'button' => [
                                'use' => true,
                                'text' => 'Оставить заявку',
                                'font' => 'modern',
                                'align' => 'right',
                                'rounded' => true,
                                'color' => [
                                    'text' => '#ffffff',
                                    'background' => '#3bc8f5',
                                ],
                            ],
                        ],
                    ],
                    'auto' => [
                        'settings' => [
                            'type' => 'panel',
                            'delay' => 10,
                        ],
                    ],
                ],
            ]
        );

    $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.embedding.update',
    {
        id: 49,
        updatedTime: '2026-10-21T17:48:29+03:00',
        fields: {
            click: {
                settings: {
                    type: 'popup',
                    position: 'left',
                    vertical: 'bottom',
                    button: {
                        use: true,
                        text: 'Оставить заявку',
                        font: 'modern',
                        align: 'right',
                        rounded: true,
                        color: {
                            text: '#ffffff',
                            background: '#3bc8f5',
                        },
                    },
                },
            },
            auto: {
                settings: {
                    type: 'panel',
                    delay: 10,
                },
            },
        },
    },
    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.embedding.update',
    [
        'id' => 49,
        'updatedTime' => '2026-10-21T17:48:29+03:00',
        'fields' => [
            'click' => [
                'settings' => [
                    'type' => 'popup',
                    'position' => 'left',
                    'vertical' => 'bottom',
                    'button' => [
                        'use' => true,
                        'text' => 'Оставить заявку',
                        'font' => 'modern',
                        'align' => 'right',
                        'rounded' => true,
                        'color' => [
                            'text' => '#ffffff',
                            'background' => '#3bc8f5',
                        ],
                    ],
                ],
            ],
            'auto' => [
                'settings' => [
                    'type' => 'panel',
                    'delay' => 10,
                ],
            ],
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
res, err := client.Core().Call(ctx, "crm.form.embedding.update", b24.Params{
	"id":          49,
	"updatedTime": "2026-10-21T17:48:29+03:00",
	"fields": map[string]any{
		"click": map[string]any{
			"settings": map[string]any{
				"type":     "popup",
				"position": "left",
				"vertical": "bottom",
				"button": map[string]any{
					"use":     true,
					"text":    "Оставить заявку",
					"font":    "modern",
					"align":   "right",
					"rounded": true,
					"color": map[string]any{
						"text":       "#ffffff",
						"background": "#3bc8f5",
					},
				},
			},
		},
		"auto": map[string]any{
			"settings": map[string]any{
				"type":  "panel",
				"delay": 10,
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("crm.form.embedding.update: %w", err)
}

var result struct {
	Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(result.Result)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "result": true
    },
    "time": {
        "start": 1792594145,
        "finish": 1792594146.982679,
        "duration": 1.9826788902282715,
        "processing": 1,
        "date_start": "2026-10-21T17:49:05+03:00",
        "date_finish": "2026-10-21T17:49:06+03:00",
        "operating_reset_at": 1792594740,
        "operating": 1.0246188640594482
    }
}

Возвращаемые данные

Название
тип

Описание

result
boolean

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

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

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 409

{
    "error": {
        "code": "CRM_FORM_VERSION_MISMATCH",
        "message": "Версия CRM-формы устарела, изменения не сохранены: получите форму заново и повторите запрос",
        "currentUpdatedTime": "2026-10-21T17:49:05+03:00"
    }
}

В ошибке CRM_FORM_VERSION_MISMATCH поле currentUpdatedTime содержит текущую версию формы. Ее можно передать в updatedTime при повторном запросе, если вы уверены, что изменения другого пользователя можно перезаписать.

Название
тип

Описание

error.code
string

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

error.message
string

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

error.validation
array

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

error.validation[].field
string

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

error.validation[].message
string

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

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

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

HTTP-статус: 400

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Если в fields несколько ошибок, метод возвращает их вместе в массиве validation.

Поле

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

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

updatedTime

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

Передайте updatedTime из ответа crm.form.get

updatedTime

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

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

filter

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

Уберите filter из запроса и передайте id формы

inline

inline carries no settings of its own

Не передавайте inline: у этого варианта нет настроек

click

click is cleared through its own settings, not as a whole

Не передавайте null для всего варианта. Чтобы сбросить настройку, передайте null для нее, например click.settings.type

click.settings.delay

click.settings.delay is no setting of the click variant

Передавайте delay только в auto.settings, а button — только в click.settings

click.code

click.code is no setting of the click variant

Передавайте внутри варианта только объект settings

publicUrl

publicUrl is published for reading only

Не передавайте formActive, resourcesReady и publicUrl: они доступны только для чтения

click.settings.type

click.settings.type accepts one of: popup, panel

Передайте значение из click.options ответа crm.form.embedding.get

auto.settings.delay

auto.settings.delay accepts one of: 3, 5, 7, 10, 15, 20, 25, 30, 40, 60, 120

Передайте значение из auto.options.delay

click.settings.button.color.text

click.settings.button.color.text expects a hex colour, #3bc8f5 or #3eddffa6

Передайте цвет в формате HEX

click.settings.button.text

click.settings.button.text is longer than 255 characters

Сократите текст кнопки до 255 символов

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

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

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

-

Неизвестное поле click.settings.size для сущности EmbeddingDto

Передайте только настройки из описания параметра fields

Ошибки версии и состояния формы

Код ошибки: CRM_FORM_VERSION_MISMATCH

HTTP-статус: 409

Поле

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

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

-

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

Получите актуальное updatedTime методом crm.form.get или возьмите его из currentUpdatedTime и повторите запрос

Код ошибки: CRM_FORM_SYSTEM_IMMUTABLE

HTTP-статус: 403

Поле

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

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

-

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

Системную форму изменить нельзя. Выберите форму, у которой в ответе crm.form.get поле system равно false

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

HTTP-статус: 404

Поле

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

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

id

Запись с ID = 999999 не найдена

Проверьте идентификатор формы методом crm.form.list

Ошибки доступа и тарифа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP-статус: 403

Поле

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

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

-

Доступ запрещен

Проверьте, что у пользователя есть право на изменение CRM-форм

Код ошибки: CRM_FORM_WRITE_RESTRICTED

HTTP-статус: 402

Поле

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

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

-

На этом тарифе нельзя изменять CRM-формы

Перейдите на тариф, в котором доступно редактирование CRM-форм

Код ошибки: CRM_FORM_PHONE_VERIFICATION_REQUIRED

HTTP-статус: 403

Поле

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

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

-

Подтвердите номер телефона в Битрикс24, чтобы работать с CRM-формами

Подтвердите номер телефона в Битрикс24 и повторите запрос

Ошибка после сохранения

Код ошибки: CRM_FORM_SIDE_EFFECT_FAILED

HTTP-статус: 500

Поле

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

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

-

Не удалось завершить действие, но данные CRM-формы уже изменены: проверьте состояние формы перед повторной попыткой

Настройки сохранены, но файлы формы не пересобраны. Проверьте настройки методом crm.form.embedding.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

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

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