Create a Sales Intelligence Trace: crm.tracking.trace.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:

any user can create a trace

a user with permission to modify the object can link the trace

The method crm.tracking.trace.add creates a Sales Intelligence trace and returns its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

TRACE^*
string

JSON string containing trace data.

You can retrieve a ready-to-use value on the website via b24Tracker.guest.getTrace(). A practical scenario is described in the tutorial.

If you create TRACE manually, pass UTM parameters in the tags.list object:

{"tags":{"list":{"utm_source":"google-maps"}}}

In this example, only one UTM parameter is passed to the trace: utm_source with the value google-maps. To pass other UTM parameters, add them to tags.list, for example utm_medium, utm_campaign, utm_content, or utm_term

ENTITIES
object[]

Array of objects to be linked with the trace (detailed description)

If ENTITIES is not passed, the method creates a trace without linking it to CRM objects

Parameter ENTITIES

Name
type

Description

TYPE^*
string

CRM object type.

Possible values:

COMPANY — company, entityTypeId = 4
CONTACT — contact, entityTypeId = 3
DEAL — deal, entityTypeId = 2
LEAD — lead, entityTypeId = 1
QUOTE — estimate, entityTypeId = 7

ID^*
integer

CRM object identifier.

You can retrieve the identifier using the crm.item.list method with entityTypeId of the required object type.

The user must have modification rights for the specified object

Code Examples

How to Use Examples in Documentation

Example of creating a Sales Intelligence trace, where:

TRACE — JSON string with the utm_source UTM parameter and the value google-maps
ENTITIES — contact and lead linked to the trace

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "TRACE": "{\"tags\":{\"list\":{\"utm_source\":\"google-maps\"}}}",
            "ENTITIES": [
              {
                "TYPE": "CONTACT",
                "ID": 17
              },
              {
                "TYPE": "LEAD",
                "ID": 1000739
              }
            ]
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/crm.tracking.trace.add.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "TRACE": "{\"tags\":{\"list\":{\"utm_source\":\"google-maps\"}}}",
            "ENTITIES": [
              {
                "TYPE": "CONTACT",
                "ID": 17
              },
              {
                "TYPE": "LEAD",
                "ID": 1000739
              }
            ],
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/crm.tracking.trace.add.json"

// 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
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'crm.tracking.trace.add',
            params: {
              TRACE: '{"tags":{"list":{"utm_source":"google-maps"}}}',
              ENTITIES: [
                {
                  TYPE: 'CONTACT',
                  ID: 17,
                },
                {
                  TYPE: 'LEAD',
                  ID: 1000739,
                },
              ],
            },
            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('Created trace ID:', result)
          }
        } 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 addTrackingTrace() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.tracking.trace.add',
                params: {
                  TRACE: '{"tags":{"list":{"utm_source":"google-maps"}}}',
                  ENTITIES: [
                    {
                      TYPE: 'CONTACT',
                      ID: 17,
                    },
                    {
                      TYPE: 'LEAD',
                      ID: 1000739,
                    },
                  ],
                },
                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('Created trace ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addTrackingTrace)
        </script>


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.tracking.trace.add(
                trace="{\"tags\":{\"list\":{\"utm_source\":\"google-maps\"}}}",
                entities=[
                    {
                        "TYPE": "CONTACT",
                        "ID": 17
                    },
                    {
                        "TYPE": "LEAD",
                        "ID": 1000739
                    }
                ],
            )
            result = bitrix_response.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.tracking.trace.add',
                    [
                        'TRACE' => '{"tags":{"list":{"utm_source":"google-maps"}}}',
                        'ENTITIES' => [
                            [
                                'TYPE' => 'CONTACT',
                                'ID' => 17,
                            ],
                            [
                                'TYPE' => 'LEAD',
                                'ID' => 1000739,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding trace: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.tracking.trace.add',
            {
                TRACE: '{"tags":{"list":{"utm_source":"google-maps"}}}',
                ENTITIES: [
                    {
                        TYPE: 'CONTACT',
                        ID: 17
                    },
                    {
                        TYPE: 'LEAD',
                        ID: 1000739
                    }
                ]
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

$result = CRest::call(
            'crm.tracking.trace.add',
            [
                'TRACE' => '{"tags":{"list":{"utm_source":"google-maps"}}}',
                'ENTITIES' => [
                    [
                        'TYPE' => 'CONTACT',
                        'ID' => 17,
                    ],
                    [
                        'TYPE' => 'LEAD',
                        'ID' => 1000739,
                    ],
                ],
            ]
        );
        
        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.tracking.trace.add", b24.Params{
            "TRACE": "{\"tags\":{\"list\":{\"utm_source\":\"google-maps\"}}}",
        	"ENTITIES": []b24.Params{
        		{
        			"TYPE": "CONTACT",
                    "ID":   17,
        		},
        		{
        			"TYPE": "LEAD",
                    "ID":   1000739,
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.tracking.trace.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)

Response Handling

HTTP status: 200

{
            "result": 1581,
            "time": {
                "start": 1786711683,
                "finish": 1786711683.296598,
                "duration": 0.296597957611084,
                "processing": 0,
                "date_start": "2026-08-14T15:48:03+03:00",
                "date_finish": "2026-08-14T15:48:03+03:00",
                "operating_reset_at": 1786712283,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the created trace
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "ERROR_CORE",
            "error_description": "Parameter `TRACE` required."
        }

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

Status	Code	Description	Value
`400`	`ERROR_CORE`	Parameter `TRACE` required.	The `TRACE` parameter is not provided
`400`	`ERROR_CORE`	Can not parse JSON in parameter `TRACE`.	The value `TRACE` is not a valid JSON string
`400`	`ERROR_CORE`	Wrong TYPE in parameter `ENTITIES`. Allowed types: COMPANY,CONTACT,DEAL,LEAD,QUOTE	An invalid `TYPE` was passed in `ENTITIES`
`400`	`ERROR_CORE`	Wrong ID in parameter `ENTITIES`.	An incorrect `ID` was passed in `ENTITIES`
`400`	`ERROR_CORE`	You have no access to entity `<TYPE>` with ID `<ID>`.	No permission to modify the object specified in `ENTITIES`

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

Was the article helpful?

Overview of Methods

Delete a Sales Intelligence Trace

Create a Sales Intelligence Trace: crm.tracking.trace.add

Method ParametersMethod Parameters

Parameter ENTITIESParameter ENTITIES

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