Add a Timeline Record Binding with a CRM Entity crm.timeline.bindings.bind
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 permission to modify the CRM entity the record is bound to
Adds a binding between a timeline record and a CRM entity. After that, the record is displayed in the timeline of the specified entity.
The binding with the entity in which the timeline record was created appears automatically — there is no need to call the method for it separately.
A repeated call with the same OWNER_ID, ENTITY_TYPE, and ENTITY_ID values does not create a duplicate and returns true. The method does not check whether the CRM entity and the timeline record exist — verify the identifiers before calling it.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values (detailed description provided below) for adding a binding of a timeline record to a CRM entity in the form of a structure:
|
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
OWNER_ID* |
Identifier of the timeline record. Obtain it from the response of the method crm.timeline.comment.add or crm.timeline.logmessage.add, or retrieve it from the list using the method crm.timeline.comment.list or crm.timeline.logmessage.list |
|
ENTITY_ID* |
Identifier of the CRM entity to which the timeline record is bound |
|
ENTITY_TYPE* |
String code of the CRM object type
How the string type codes are structured is described in the section CRM Object Type. Not all codes from that table are suitable: the method does not accept the requisites code If the type code is not supported or there is no smart process with such |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_ID":1110,"ENTITY_ID":10,"ENTITY_TYPE":"deal"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.bindings.bind
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_ID":1110,"ENTITY_ID":10,"ENTITY_TYPE":"deal"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.bindings.bind
// 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<boolean>({
method: 'crm.timeline.bindings.bind',
params: {
fields: {
OWNER_ID: 1110,
ENTITY_ID: 10,
ENTITY_TYPE: 'deal',
},
},
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('Binding created:', 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@2/dist/umd/index.min.js"></script>
<script>
async function createBinding() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.bindings.bind',
params: {
fields: {
OWNER_ID: 1110,
ENTITY_ID: 10,
ENTITY_TYPE: 'deal',
},
},
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('Binding created:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', createBinding)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.timeline.bindings.bind(
fields={
"OWNER_ID": 1110,
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
).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.timeline.bindings.bind',
[
'fields' => [
'OWNER_ID' => 1110,
'ENTITY_ID' => 10,
'ENTITY_TYPE' => 'deal',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error binding timeline: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.bindings.bind",
{
fields: {
"OWNER_ID": 1110,
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.bindings.bind',
[
'fields' => [
'OWNER_ID' => 1110,
'ENTITY_ID' => 10,
'ENTITY_TYPE' => 'deal',
]
]
);
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.timeline.bindings.bind", b24.Params{
"fields": b24.Params{
"OWNER_ID": 1110,
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
},
})
if err != nil {
return fmt.Errorf("crm.timeline.bindings.bind: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP status: 200
{
"result": true,
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Returned Data
|
Name |
Description |
|
result |
Returns Returns |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "OWNER_ID is not defined or invalid."
}
|
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
|
Status |
Code |
Description |
Value |
|
|
Empty value |
OWNER_ID is not defined or invalid. |
The required parameter |
|
|
Empty value |
ENTITY_ID is not defined or invalid. |
The required parameter |
|
|
Empty value |
ENTITY_TYPE is not defined or invalid. |
The required parameter |
|
|
|
Wrong params. |
The |
If permission is denied, the method returns false rather than an error.
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 |
Continue Learning
- Retrieve a List of Timeline Record Bindings with CRM Entities crm.timeline.bindings.list
- Remove a Timeline Record Binding with a CRM Entity crm.timeline.bindings.unbind
- Retrieve Fields of a Timeline Record Binding with a CRM Entity crm.timeline.bindings.fields
- Timeline Record Bindings with CRM Entities: Overview of Methods