Add Badge crm.activity.badge.add
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 administrative access to the CRM section
The method crm.activity.badge.add registers a badge — an icon that appears on the card of a CRM object in the kanban.
The method only registers the badge and does not attach it to a CRM object. For the icon to appear, pass the badge code in the badgeCode field of a configurable activity when calling crm.activity.configurable.add or crm.activity.configurable.update.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
code* |
Badge code, for example |
|
title* |
Badge name. A string, or an object with translations where the key is a language code |
|
value* |
Text inside the icon, displayed in uppercase. A string or an object with translations |
|
type* |
Badge type. Defines the icon color: |
The codes already in use are returned by the crm.activity.badge.list method.
In an object with translations, the keys can only be language codes that Bitrix24 recognizes, for example ru, en, de.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"code":"missedCall","title":"Call Status","value":"Missed","type":"failure"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.badge.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"code":"missedCall","title":"Call Status","value":"Missed","type":"failure","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.badge.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type BadgeAddResult = {
badge: {
code: string
// title and value come as a string or as an object with translations
title: string | Record<string, string>
value: string | Record<string, string>
type: string
}
}
try {
const response = await $b24.actions.v2.call.make<BadgeAddResult>({
method: 'crm.activity.badge.add',
params: {
code: 'missedCall',
title: 'Call Status',
value: 'Missed',
type: 'failure',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.badge)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addActivityBadge() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.badge.add',
params: {
code: 'missedCall',
title: 'Call Status',
value: 'Missed',
type: 'failure',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.badge)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addActivityBadge)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.badge.add(
code="missedCall",
title="Call Status",
value="Missed",
type="failure",
).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}")
try {
$response = $b24Service
->core
->call(
'crm.activity.badge.add',
[
'code' => 'missedCall',
'title' => 'Call Status',
'value' => 'Missed',
'type' => 'failure'
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
"crm.activity.badge.add",
{
code: 'missedCall',
title: 'Call Status',
value: 'Missed',
type: 'failure'
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.badge.add',
[
'code' => 'missedCall',
'title' => 'Call Status',
'value' => 'Missed',
'type' => 'failure'
]
);
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.activity.badge.add", b24.Params{
"code": "missedCall",
"title": "Call Status",
"value": "Missed",
"type": "failure",
})
if err != nil {
return fmt.Errorf("crm.activity.badge.add: %w", err)
}
// The method wraps the response in an object with the "badge" key.
raw, ok := b24.Unwrap(res.Result, "badge")
if !ok {
return fmt.Errorf("no badge key in the response")
}
var item struct {
Code string `json:"code"`
// Title and Value come as a string or as an object with translations
Title any `json:"title"`
Value any `json:"value"`
Type string `json:"type"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Code, item.Title)
Response Handling
HTTP Status: 200
{
"result": {
"badge": {
"code": "missedCall",
"title": "Call Status",
"value": "Missed",
"type": "failure"
}
},
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+02:00",
"date_finish": "2025-01-21T13:47:08+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response with a single badge key (detailed description) |
|
time |
Information about the request execution time |
Badge Object
|
Name |
Description |
|
code |
Badge code. Pass it in the |
|
title |
Badge name exactly as it was passed |
|
value |
Text inside the icon |
|
type |
Error Handling
HTTP Status: 400
{
"error": "BX_INVALID_VALUE",
"error_description": "Code must be unique"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions: the method is available only to a user with administrative access to the CRM section |
|
|
A required parameter is missing. Its name comes in the error description, for example |
|
|
The |
|
|
The value of the |
|
|
A badge with this code is already registered: |
|
|
General validation error code. The reason comes in |
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 |