Configurable Activity Badges: Overview of Methods

A badge is an icon on the card of a CRM object 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.

Quick navigation: all methods

Link with a Configurable ActivityLink with a Configurable Activity

A badge is not linked to a CRM entity directly. First, the application registers the badge using the crm.activity.badge.add method, and then specifies its code in the badgeCode field of a configurable activity when calling crm.activity.configurable.add or crm.activity.configurable.update.

The badge is displayed on the kanban of the object to which the activity is linked until the activity is closed.

Considerations Before Calling MethodsConsiderations Before Calling Methods

• The methods crm.activity.badge.add and crm.activity.badge.delete can only be executed by a user with administrative access to the CRM section.
• The methods crm.activity.badge.get and crm.activity.badge.list are available to any user.
• The badge code must be unique. A badge with a code that is already taken cannot be added.
• A badge is retrieved and deleted by its code, not by its identifier.

How to Work with BadgesHow to Work with Badges

1. Check the codes already in use with the crm.activity.badge.list method.
2. Register the badge with the crm.activity.badge.add method.
3. Check the badge by its code with the crm.activity.badge.get method.
4. Specify the badge code in the badgeCode field of the configurable activity.
5. Delete a badge you no longer need with the crm.activity.badge.delete method.

Badge Record FieldsBadge Record Fields

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 TypeBadge 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 MethodsOverview of Methods

Scope: crm

Who can execute the method: a user with administrative access to the crm section — for crm.activity.badge.add and crm.activity.badge.delete, any user — for crm.activity.badge.get and crm.activity.badge.list

AdditionalAdditional

• Add Configurable Activity crm.activity.configurable.add
• Update Configurable Activity crm.activity.configurable.update
• Get Configurable Activity by ID crm.activity.configurable.get