Update CRM Form Placement Settings crm.form.embedding.update
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with permission to edit CRM forms
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The method crm.form.embedding.update saves the on-click display and auto-display settings of a CRM form.
The method changes the form version updatedTime. Before the next change to the form or its placement, retrieve the new version with the crm.form.get method.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
CRM form identifier. The identifier can be obtained using the crm.form.list method |
|
updatedTime* |
Form version — the date of the last change in ISO 8601 format, for example The value can be obtained from the |
|
fields* |
Settings to change. Settings that are not passed remain unchanged. To reset a setting, pass |
Parameter fields
The fields structure follows the structure of the crm.form.embedding.get response: the option settings are passed in the settings object inside click or auto. Other response fields cannot be changed, and the inline option has no settings.
|
Name |
Description |
|
click.settings |
On-click display settings of the form, detailed description |
|
auto.settings |
Auto-display settings of the form, detailed description |
Click.settings Object
The allowed values of type, position, vertical, button.font, and button.align are returned by the crm.form.embedding.get method in the click.options object.
|
Name |
Description |
|
type |
Form window type. Possible values:
|
|
position |
Horizontal position of the window. Possible values:
|
|
vertical |
Vertical position of the window. Possible values:
|
|
button |
Button settings, detailed description |
Click.settings.button Object
|
Name |
Description |
|
use |
Whether to show the Bitrix24 button on the website. Possible values:
|
|
text |
Button text, no longer than 255 characters |
|
font |
Button font. Possible values:
|
|
align |
Button alignment. Possible values:
|
|
plain |
Button without a background. Possible values:
|
|
rounded |
Rounded button corners. Possible values:
|
|
outlined |
Button outline. Possible values:
|
|
decoration |
Button text underline, no longer than 20 characters. The interface uses the values |
|
color |
Button colors in HEX format:
|
Auto.settings Object
The allowed values are returned by the crm.form.embedding.get method in the auto.options object.
|
Name |
Description |
|
type |
Form window type: |
|
position |
Horizontal position of the window: |
|
vertical |
Vertical position of the window: |
|
delay |
Auto-display delay in seconds. Possible values: |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/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+02:00","fields":{"click":{"settings":{"type":"popup","position":"left","vertical":"bottom","button":{"use":true,"text":"Submit a request","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+02:00","fields":{"click":{"settings":{"type":"popup","position":"left","vertical":"bottom","button":{"use":true,"text":"Submit a request","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+02:00',
fields: {
click: {
settings: {
type: 'popup',
position: 'left',
vertical: 'bottom',
button: {
use: true,
text: 'Submit a request',
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+02:00',
fields: {
click: {
settings: {
type: 'popup',
position: 'left',
vertical: 'bottom',
button: {
use: true,
text: 'Submit a request',
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": "Submit a request",
"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+02:00",
fields=fields,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'crm.form.embedding.update',
[
'id' => 49,
'updatedTime' => '2026-10-21T17:48:29+02:00',
'fields' => [
'click' => [
'settings' => [
'type' => 'popup',
'position' => 'left',
'vertical' => 'bottom',
'button' => [
'use' => true,
'text' => 'Submit a request',
'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();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'crm.form.embedding.update',
{
id: 49,
updatedTime: '2026-10-21T17:48:29+02:00',
fields: {
click: {
settings: {
type: 'popup',
position: 'left',
vertical: 'bottom',
button: {
use: true,
text: 'Submit a request',
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());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'crm.form.embedding.update',
[
'id' => 49,
'updatedTime' => '2026-10-21T17:48:29+02:00',
'fields' => [
'click' => [
'settings' => [
'type' => 'popup',
'position' => 'left',
'vertical' => 'bottom',
'button' => [
'use' => true,
'text' => 'Submit a request',
'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+02: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": "Submit a request",
"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("parsing the response: %w", err)
}
fmt.Println(result.Result)
Response Handling
HTTP status: 200
{
"result": {
"result": true
},
"time": {
"start": 1792594145,
"finish": 1792594146.982679,
"duration": 1.9826788902282715,
"processing": 1,
"date_start": "2026-10-21T17:49:05+02:00",
"date_finish": "2026-10-21T17:49:06+02:00",
"operating_reset_at": 1792594740,
"operating": 1.0246188640594482
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains an object with the |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 409
{
"error": {
"code": "CRM_FORM_VERSION_MISMATCH",
"message": "Could not save changes because the CRM form version is outdated. Retrieve the form again and retry the request.",
"currentUpdatedTime": "2026-10-21T17:49:05+02:00"
}
}
In the CRM_FORM_VERSION_MISMATCH error, the currentUpdatedTime field contains the current form version. You can pass it in updatedTime when repeating the request if you are sure that another user's changes can be overwritten.
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
HTTP status: 400
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
If fields contains several errors, the method returns them together in the validation array.
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass |
|
|
This request requires data type |
Pass the date in ISO 8601 format, for example |
|
|
crm.form.embedding.update changes the embedding of one form addressed by id and takes no filter. |
Remove |
|
|
|
Do not pass |
|
|
|
Do not pass |
|
|
|
Pass |
|
|
|
Pass only the |
|
|
|
Do not pass |
|
|
|
Pass a value from |
|
|
|
Pass a value from |
|
|
|
Pass the color in HEX format |
|
|
|
Shorten the button text to 255 characters |
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass only the settings from the |
Form Version and State Errors
Error Code: CRM_FORM_VERSION_MISMATCH
HTTP status: 409
|
Field |
Error description |
How to Fix |
|
|
Could not save changes because the CRM form version is outdated. Retrieve the form again and retry the request |
Retrieve the current |
Error Code: CRM_FORM_SYSTEM_IMMUTABLE
HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Cannot edit or delete this CRM form |
A system form cannot be changed. Choose a form whose |
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
Check the form identifier with the crm.form.list method |
Access and Plan Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Check that the user has permission to edit CRM forms |
Error Code: CRM_FORM_WRITE_RESTRICTED
HTTP status: 402
|
Field |
Error description |
How to Fix |
|
|
You cannot modify CRM forms on your plan |
Switch to a plan that includes editing CRM forms |
Error Code: CRM_FORM_PHONE_VERIFICATION_REQUIRED
HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
You have to confirm your Bitrix24 phone number to use CRM forms |
Verify the phone number in Bitrix24 and repeat the request |
Post-Save Error
Error Code: CRM_FORM_SIDE_EFFECT_FAILED
HTTP status: 500
|
Field |
Error description |
How to Fix |
|
|
Operation failed but CRM form data was modified. Check the form before trying again |
The settings are saved, but the form files were not rebuilt. Check the settings with the crm.form.embedding.get method and repeat the request |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |