Update a Card View v 3.0 crm.[type].detailpagelayout.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: crm

Who can execute the method: any user — their own personal view; the common and additional views — a user with permission to edit the common card view of this object type, for example, a CRM administrator; another user's personal view — a CRM administrator

This 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 crm.<type>.detailpagelayout.update method updates a personal, common, or additional card view for CRM items. The object type is set by the <type> segment of the method name.

For the personal and common views, only the set of sections and fields configuration can be changed. For an additional view, you can also change the name name and the audience audience. The method changes only the fields keys that are passed, and each passed key replaces the whole value: a new configuration array replaces all sections, and a new audience array replaces all members.

Method Name for the Object Type

Object type	Method
Deal	`crm.deal.detailpagelayout.update`
Lead	`crm.lead.detailpagelayout.update`
Contact	`crm.contact.detailpagelayout.update`
Company	`crm.company.detailpagelayout.update`
Estimate	`crm.quote.detailpagelayout.update`
Invoice	`crm.smartinvoice.detailpagelayout.update`
CRM document	`crm.smartdocument.detailpagelayout.update`
B2E document	`crm.smartb2edocument.detailpagelayout.update`
SPA	`crm.smartprocess<entityTypeId>.detailpagelayout.update`, for example, `crm.smartprocess1038.detailpagelayout.update`

For an SPA, the method name includes its type ID entityTypeId. Type IDs can be retrieved with the crm.type.list method. Card view methods are available for an SPA regardless of the type settings. My company has no such methods.

The method name is written in lowercase: crm.deal.detailpagelayout.update, not crm.deal.detailPageLayout.update. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `string`	Card view ID, a string: `C<categoryId>:personal` — the personal view, for example, `C69:personal` `C<categoryId>:common` — the common view, for example, `C69:common` a number in a string, for example, `"17"` — an additional view Leads and estimates have no pipelines, so their personal and common views are `personal` and `common`. Leads also have separate views for repeat leads: `personal_returning_customer` and `common_returning_customer`. The view must belong to the pipeline from `categoryId`. IDs of the personal and common views are returned by the crm.<type>.detailpagelayout.getpersonallayoutid and crm.<type>.detailpagelayout.getcommonlayoutid methods, and IDs of additional views by the crm.<type>.detailpagelayout.list method
categoryId* `integer`	Pipeline ID. Card views are stored separately for each pipeline. The value depends on the object type: lead and estimate — only `0`, as they have no pipelines deal, contact, and company — the pipeline ID; `0` is the default pipeline invoice, documents, and SPA — the pipeline ID. The method replaces the value `0` with the ID of the default pipeline Pipeline IDs of deals, contacts, companies, and SPAs can be retrieved with the crm.<type>.category.list method
userId `integer`	ID of the user whose view to update. Required to update another user's personal view. Only a CRM administrator can pass the ID of another user. Defaults to the user who calls the method. User IDs can be retrieved with the user.get method
fields* `object`	New view values (detailed description)

The fields Parameter

Pass at least one key.

Name `type`	Description
configuration `object[]`	Card sections in display order (detailed description). The array replaces all sections of the view, so pass the whole configuration. The current configuration is returned by the crm.<type>.detailpagelayout.get method
name `string`	New name of the additional view, up to 100 characters. The personal and common views have no name
audience `object[]`	New list of members of the additional view, at least one (detailed description). The list replaces the previous one entirely. The user who calls the method is not added to the audience automatically. The personal and common views have no audience

The configuration Parameter

An array of card sections in display order. Each section is an object:

Required parameters are marked with *

Name `type`	Description
name* `string`	Section code, unique within the view, for example, `main`
title* `string`	Section title in the card
elements* `object[]`	Section fields in display order (detailed description). You can pass an empty array

Section Field

Name `type`	Description
name* `string`	Field name in the card: `TITLE`, `STAGE_ID`, `OPPORTUNITY_WITH_CURRENCY`, custom field `UF_CRM_1687529546`. The names are written in uppercase and do not match the item field names in REST 3.0
optionFlags `integer`	Whether to show the field when it is empty. Possible values: `1` — always show `0` — show only if the field is filled in
options `object`	Field settings in the format `{"setting": "value"}`, for example, `{"defaultCountry": "DE"}` for a phone number. The set of settings depends on the field. Field settings are available in the view configuration returned by the crm.<type>.detailpagelayout.get method

The method does not check whether the object type has a field with this name: a view with an unknown field name is saved. Take ready-made field names and their settings from the common view configuration, which is returned by the crm.<type>.detailpagelayout.get method with the ID from crm.<type>.detailpagelayout.getcommonlayoutid.

The audience Parameter

An array of members who can access the additional view. Each member is an object:

Required parameters are marked with *

Name
type

Description

type*
string

Member type.

Possible values:

user — an employee. The ID can be retrieved with the user.get method
department — a department together with its subdepartments. The ID can be retrieved with the department.get method
project — a group or project. The ID can be retrieved with the sonet_group.get method
structure-node — a company structure node together with its child nodes

id*
integer

Member ID, a positive number

The audience can have up to 1000 members.

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.smartprocess1038.detailpagelayout.update

The examples change the name and audience of the additional view 17 of an SPA with the type ID 1038: the view becomes available to department 47 and employee 29. For a different object type, replace the method name according to the table above.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"categoryId":0,"id":"17","fields":{"name":"Procurement and warehouse card","audience":[{"type":"department","id":47},{"type":"user","id":29}]}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.detailpagelayout.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"categoryId":0,"id":"17","fields":{"name":"Procurement and warehouse card","audience":[{"type":"department","id":47},{"type":"user","id":29}]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.detailpagelayout.update

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type LayoutChangeResult = {
          result: boolean
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<LayoutChangeResult>(
            'crm.smartprocess1038.detailpagelayout.update',
            {
              categoryId: 0,
              id: '17',
              fields: {
                name: 'Procurement and warehouse card',
                audience: [
                  { type: 'department', id: 47 },
                  { type: 'user', id: 29 },
                ],
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Layout updated:', result.result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateLayout() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.detailpagelayout.update',
                {
                  categoryId: 0,
                  id: '17',
                  fields: {
                    name: 'Procurement and warehouse card',
                    audience: [
                      { type: 'department', id: 47 },
                      { type: 'user', id: 29 },
                    ],
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Layout updated:', result.result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateLayout)
        </script>

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.smartprocess1038.detailpagelayout.update"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "categoryId": 0,
                    "id": "17",
                    "fields": {
                        "name": "Procurement and warehouse card",
                        "audience": [
                            {"type": "department", "id": 47},
                            {"type": "user", "id": 29},
                        ],
                    },
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result["result"])
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                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.smartprocess1038.detailpagelayout.update',
                    [
                        'categoryId' => 0,
                        'id' => '17',
                        'fields' => [
                            'name' => 'Procurement and warehouse card',
                            'audience' => [
                                ['type' => 'department', 'id' => 47],
                                ['type' => 'user', 'id' => 29],
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $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.smartprocess1038.detailpagelayout.update',
            {
                categoryId: 0,
                id: '17',
                fields: {
                    name: 'Procurement and warehouse card',
                    audience: [
                        { type: 'department', id: 47 },
                        { type: 'user', id: 29 },
                    ],
                },
            },
            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.smartprocess1038.detailpagelayout.update',
            [
                'categoryId' => 0,
                'id' => '17',
                'fields' => [
                    'name' => 'Procurement and warehouse card',
                    'audience' => [
                        ['type' => 'department', 'id' => 47],
                        ['type' => 'user', 'id' => 29],
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.smartprocess1038.detailpagelayout.update", b24.Params{
        	"categoryId": 0,
        	"id":         "17",
        	"fields": b24.Params{
        		"name": "Procurement and warehouse card",
        		"audience": []b24.Params{
        			{"type": "department", "id": 47},
        			{"type": "user", "id": 29},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.detailpagelayout.update: %w", err)
        }
        
        var answer struct {
        	Result bool `json:"result"`
        }
        if err := json.Unmarshal(res.Result, &answer); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(answer.Result)

Response Handling

HTTP status: 200

{
            "result": {
                "result": true
            },
            "time": {
                "start": 1793706651,
                "finish": 1793706651.905107,
                "duration": 0.9051070213317871,
                "processing": 0,
                "date_start": "2026-11-03T14:50:51+03:00",
                "date_finish": "2026-11-03T14:50:51+03:00",
                "operating_reset_at": 1793707200,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with response data
result.result `boolean`	`true` if the view was updated
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "INVALID_LAYOUT_AUDIENCE",
                "message": "Invalid form layout audience."
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Card view errors are returned with short codes without the BITRIX_REST_V3_ prefix, for example, LAYOUT_NOT_FOUND, and with English messages. The HTTP status of these errors varies and is given next to the code. Errors with BITRIX_REST_V3_* codes are returned with status 400.

Invalid View Configuration

Error Code: INVALID_LAYOUT_CONFIGURATION, HTTP status: 400

Field	Error description	How to Fix
`-`	Invalid form layout configuration	Do not pass `name` for the personal and common views. Check that `name` is no longer than 100 characters and that `configuration` is not an empty array

Invalid View Audience

Error Code: INVALID_LAYOUT_AUDIENCE, HTTP status: 400

Field	Error description	How to Fix
`-`	Invalid form layout audience	Do not pass `audience` for the personal and common views. Check that `audience` is not an empty array and has no more than 1000 members

Invalid Card View ID

Error Code: INVALID_LAYOUT_ID, HTTP status: 400

Field	Error description	How to Fix
`-`	Invalid form layout ID	Check the `id` format and the pipeline: the view ID must belong to the pipeline from `categoryId`

Card View Not Found

Error Code: LAYOUT_NOT_FOUND, HTTP status: 404

Field	Error description	How to Fix
`-`	The form layout was not found	Check `id`: the additional view does not exist, belongs to another pipeline, or the user has no access to it

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`categoryId`	Required field `categoryId` is missing	Pass `categoryId`. For a lead and an estimate, pass `0`
`categoryId`	This request requires data type `int` in field `categoryId`	Pass `categoryId` as a number, not a string
`categoryId`	Field value must be 0 or greater	Pass `0` or a pipeline ID
`userId`	Field value must be 1 or greater	Pass the ID of an existing user or do not pass `userId`
`id`	Required field `id` is missing	Pass the view ID
`id`	This request requires data type `string` in field `id`	Pass `id` as a string, for example, `"17"`
`fields`	Required field `fields` is missing	Pass at least one key in `fields`. The error is also returned for an empty `fields` object

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field	Error description	How to Fix
`audience.0.type`	Field value is not one of the possible values: user, department, project, structure-node	Pass one of the member types from the parameter description
`configuration.0.elements`	Required field `elements` is empty	Pass `name`, `title`, and `elements` in each section

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `LayoutFieldsDto`	Remove the extra key. The request accepts `id`, `categoryId`, `userId`, and `fields`

Unsupported Pipeline

Error Code: UNSUPPORTED_CONTEXT, HTTP status: 400

Field	Error description	How to Fix
`-`	This form layout context is not supported	Check `categoryId`: for a lead and an estimate, pass `0`; for other types, pass the ID of an existing pipeline of this object type

Access Denied

Error Code: PERMISSION_DENIED, HTTP status: 403

Field	Error description	How to Fix
`-`	Insufficient permissions to work with this form layout	The common and additional views are updated by a user with permission to edit the common card view, and another user's personal view by a CRM administrator

Storage Error

Error Code: STORAGE_FAILED, HTTP status: 500

Field	Error description	How to Fix
`-`	Could not complete the operation on the form layout	Retry the request later. If the error persists, contact support

Changes Partially Applied

Error Code: CONSISTENCY_FAILURE, HTTP status: 500

Field	Error description	How to Fix
`-`	Form layout changes were partially applied	Some of the changes were saved. Read the view with the crm.<type>.detailpagelayout.get method and repeat the update

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field	Error description	How to Fix
`-`	Method `#METHOD#` was not found	Check the method name: it is written in lowercase, for example, `crm.deal.detailpagelayout.update`. My company has no card view methods. For an SPA, check `entityTypeId` with the crm.type.list method

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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	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 — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Continue Learning

Was the article helpful?

Create an Additional Card View

Get a Card View

Update a Card View v 3.0 crm.[type].detailpagelayout.update

Method Name for the Object TypeMethod Name for the Object Type

Method ParametersMethod Parameters

The fields ParameterThe fields Parameter

The configuration ParameterThe configuration Parameter

Section FieldSection Field

The audience ParameterThe audience Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Invalid View ConfigurationInvalid View Configuration

Invalid View AudienceInvalid View Audience

Invalid Card View IDInvalid Card View ID

Card View Not FoundCard View Not Found

Request Validation ErrorsRequest Validation Errors

Object Validation ErrorsObject Validation Errors

Unknown Field ErrorUnknown Field Error

Unsupported PipelineUnsupported Pipeline

Access DeniedAccess Denied

Storage ErrorStorage Error

Changes Partially AppliedChanges Partially Applied

Method Not FoundMethod Not Found

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Name for the Object Type

Method Parameters

The fields Parameter

The configuration Parameter

Section Field

The audience Parameter

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Invalid View Configuration

Invalid View Audience

Invalid Card View ID

Card View Not Found

Request Validation Errors

Object Validation Errors

Unknown Field Error

Unsupported Pipeline

Access Denied

Storage Error

Changes Partially Applied

Method Not Found

Statuses and System Error Codes

Continue Learning