Изменить настройки размещения 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* |
Идентификатор CRM-формы. Идентификатор можно получить методом crm.form.list |
|
updatedTime* |
Версия формы — дата последнего изменения в формате ISO 8601, например Значение можно получить методом crm.form.get из поля |
|
fields* |
Настройки, которые нужно изменить. Непереданные настройки остаются без изменений, чтобы сбросить настройку, передайте для нее |
Параметр fields
Структура fields повторяет структуру ответа crm.form.embedding.get: настройки варианта передаются в объекте settings внутри click или auto. Другие поля ответа изменить нельзя, у варианта inline настроек нет.
|
Название |
Описание |
|
click.settings |
Настройки показа формы по клику, подробное описание |
|
auto.settings |
Настройки автопоказа формы, подробное описание |
Объект click.settings
Допустимые значения type, position, vertical, button.font и button.align возвращает метод crm.form.embedding.get в объекте click.options.
|
Название |
Описание |
|
type |
Вид окна формы. Возможные значения:
|
|
position |
Положение окна по горизонтали. Возможные значения:
|
|
vertical |
Положение окна по вертикали. Возможные значения:
|
|
button |
Настройки кнопки, подробное описание |
Объект click.settings.button
|
Название |
Описание |
|
use |
Показывать ли кнопку Битрикс24 на сайте. Возможные значения:
|
|
text |
Текст кнопки, не длиннее 255 символов |
|
font |
Шрифт кнопки. Возможные значения:
|
|
align |
Выравнивание кнопки. Возможные значения:
|
|
plain |
Кнопка без фона. Возможные значения:
|
|
rounded |
Скругленные углы кнопки. Возможные значения:
|
|
outlined |
Обводка кнопки. Возможные значения:
|
|
decoration |
Подчеркивание текста кнопки, не длиннее 20 символов. В интерфейсе используются значения |
|
color |
Цвета кнопки в формате HEX:
|
Объект auto.settings
Допустимые значения возвращает метод crm.form.embedding.get в объекте auto.options.
|
Название |
Описание |
|
type |
Вид окна формы: |
|
position |
Положение окна по горизонтали: |
|
vertical |
Положение окна по вертикали: |
|
delay |
Задержка автопоказа в секундах. Возможные значения: |
Примеры кода
Как использовать примеры в документации
Вызов нового 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 |
Корневой элемент ответа. Содержит объект с ключом |
|
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 |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
HTTP-статус: 400
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
Если в fields несколько ошибок, метод возвращает их вместе в массиве validation.
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте |
|
|
В поле |
Передайте дату в формате ISO 8601, например |
|
|
crm.form.embedding.update changes the embedding of one form addressed by id and takes no filter. |
Уберите |
|
|
|
Не передавайте |
|
|
|
Не передавайте |
|
|
|
Передавайте |
|
|
|
Передавайте внутри варианта только объект |
|
|
|
Не передавайте |
|
|
|
Передайте значение из |
|
|
|
Передайте значение из |
|
|
|
Передайте цвет в формате HEX |
|
|
|
Сократите текст кнопки до 255 символов |
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте только настройки из описания параметра |
Ошибки версии и состояния формы
Код ошибки: CRM_FORM_VERSION_MISMATCH
HTTP-статус: 409
|
Поле |
Описание ошибки |
Как исправить |
|
|
Версия CRM-формы устарела, изменения не сохранены: получите форму заново и повторите запрос |
Получите актуальное |
Код ошибки: CRM_FORM_SYSTEM_IMMUTABLE
HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Эту CRM-форму нельзя изменить или удалить |
Системную форму изменить нельзя. Выберите форму, у которой в ответе crm.form.get поле |
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
HTTP-статус: 404
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Проверьте идентификатор формы методом 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, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |