About Configurable Activity Badges
Quick navigation: all methods
A badge is an icon on the card of a CRM entity in the kanban. The badge helps highlight entities that require attention. If multiple badges are added to an entity, only the most recently added badge will be displayed.

Badges can be added for a configurable activity in the badgeCode field. The badge will be displayed on the kanban of the object to which the activity is linked until the activity is closed.
Badge Record Fields
|
Field |
Description |
|
code |
Badge code, for example |
|
title |
Title of the badge. Can be a string or an array of strings for different languages |
|
value |
Value of the badge. Can be a string or an array of strings for different languages |
|
type |
If title or value contains an array, the keys should be language codes, and the values should be text in those languages, for example:
{
"de": "Achtung",
"en": "Alarm"
}
If a translation for the current language is not found, the English version will be used. If the English translation is also not found, the first element of the array will be used.
Badge Type
In Bitrix24, there are several standard badges for different scenarios. The badge type can take the following values:
- success — Green background
- failure — Red background
- warning — Yellow background
- primary — Blue background
- secondary — Gray background
Overview of Methods
Scope:
crmWho can execute the method: any user
|
Method |
Description |
|
Adds a new badge |
|
|
Retrieves information about a badge |
|
|
Retrieves a list of badges |
|
|
Deletes a badge by code |
Additional
- Add Configurable CRM Activity `crm.activity.configurable.add`
- Update Configurable Activity crm.activity.configurable.update
- Get Configurable Activity by ID crm.activity.configurable.get