Per gli agenti AI: markdown di questa pagina — /docs-content-en/entities/crm-card-layouts.md indice della documentazione — /llms.txt
Gli articoli della documentazione sono attualmente disponibili solo in inglese.
These methods are rolling out — introduced in
crm 26.1700.0. Cloud availability also depends on Bitrix24 enabling this capability. Until it is enabled for your Bitrix24 account, the API returns422 METHOD_NOT_YET_AVAILABLEwitherror.release.
Named CRM card layouts
Keep several sets of card sections and fields, and select the current layout for an employee.
Bitrix24 API: crm.<entity>.detailpagelayout.*
Scope: crm
Operations
- Create a CRM card layout —
POST /v1/crm/card-layouts/:entityType - List CRM card layouts —
GET /v1/crm/card-layouts/:entityType - Get a CRM card layout —
GET /v1/crm/card-layouts/:entityType/:layoutId - Update a CRM card layout —
PATCH /v1/crm/card-layouts/:entityType/:layoutId - Delete a CRM card layout —
DELETE /v1/crm/card-layouts/:entityType/:layoutId - Select the current CRM layout —
PUT /v1/crm/card-layouts/:entityType/current - Get the common CRM layout ID —
GET /v1/crm/card-layouts/:entityType/common-id - Get the personal CRM layout ID —
GET /v1/crm/card-layouts/:entityType/personal-id
Key fields
| Field | Description |
|---|---|
Fieldid |
DescriptionOpaque string, including system IDs. Source: the layout list, the common layout ID or the personal layout ID. |
Fieldname |
DescriptionName. May be null for system layouts. |
Fieldconfiguration |
DescriptionSections with names and arrays of elements. |
Fieldaudience |
DescriptionEmployees and access groups {type,id}. May be null. Employee IDs come from the employee list. |
Before you start
entityType:company,contact,deal,lead,quote,smartinvoice,smartprocess<N>. Get the smart process type ID from Smart process types.- Every request requires a category. Source:
GET /v1/categories.0is a valid value. - Creation returns a numeric ID. Convert it to a string for subsequent requests.
- Bitrix24 checks access to the audience, target employee and system layout. Writes require
READWRITE. - The current card configuration is covered in a separate section: CRM card layout.
Typical workflow
- List CRM card layouts.
- Create a CRM card layout.
- Update a CRM card layout.
- Select the current CRM layout.
- Delete a CRM card layout.
Limits
The list reads one page using limit and offset. The response has no total count or hasMore. Bitrix24 checks accepted values and field limits. Empty arrays may be rejected as missing fields. Updating an array replaces it in full.