Add Badge crm.activity.badge.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: users with administrative access to the crm section

The method crm.activity.badge.add adds a new badge for a configurable activity.

Method Parameters

Required parameters are marked with *

Field	Description
code* `string`	Badge code, for example `missedCall`
title* `string`\|`array`	Badge title. Can be a string or an array of strings for different languages
value* `string`\|`array`	Badge value. Can be a string or an array of strings for different languages
type* `string`	Badge type

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'crm.activity.badge.add',
                {
                    code: 'missedCall',
                    title: 'Call Status',
                    value: 'Missed',
                    type: 'failure'
                }
            );
            
            const result = response.getData().result;
            if (result.error())
                console.error(result.error());
            else
                console.dir(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.badge.add',
                    [
                        'code'  => 'missedCall',
                        'title' => 'Call Status',
                        'value' => 'Missed',
                        'type'  => 'failure'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding activity badge: ' . $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>';

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 `type`	Description
result `object`	Root element of the response containing information about the added badge in case of success. In case of failure, it will return `null`
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "NOT_FOUND",
            "error_description": "Not found."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`ACCESS_DENIED`	Insufficient permissions to perform the operation
`REQUIRED_ARG_MISSING`	Required fields are not filled

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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

About Badges

Get Badge List

Add Badge crm.activity.badge.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning