Record Header

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.

Header of the timeline record HeaderDto.

Parameters of the HeaderDto Object

Required parameters are marked with *

Field

Description

title*
textWithTranslation

Title of the record

titleAction
ActionDto

Action upon clicking the record header

tags
TagDto[]

Associative array of objects describing tags

TagDtoObject

Tag in the timeline record header.

Warning

No more than two tags are allowed.

Parameters of the TagDto Object

Required parameters are marked with *

Field

Description

title*
textWithTranslation

Tag text

type*
string

Tag type, for example warning. Defines its appearance

action
ActionDto

Action upon clicking the tag

scope
string

Visibility scope, for example web

hideIfReadonly
boolean

Flag. Hides the tag if the user does not have edit access (default is false)

Possible values for the type field:

  • warning - Yellow background
  • success - Green background
  • failure - Red background
  • primary - Blue background
  • secondary - Gray background

Tag options

Note

The image also shows a pale purple tag lavender. It is used in internal timeline records but is not supported in configurable activities: passing it via REST will return a validation error.

Example Object

    "header": {
        "title": "Incoming call",
        "titleAction": {
            "type": "redirect",
            "uri": "some.url"
        },
        "tags": {
            "status2": {
                "type": "warning",
                "title": "not transcribed"
            }
        }
    },

Continue Learning

Previous
Icon
Next
Main Content Area