Save Note crm.timeline.note.save
Scope:
crmWho can execute the method:
any user
This method allows you to save a note.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ownerTypeId* |
Identifier of the entity type to which the record belongs |
|
ownerId* |
Identifier of the entity to which the record belongs |
|
itemType* |
Type of the record to which the note should be applied:
|
|
itemId* |
Identifier of the record to which the note should be applied. If |
|
text* |
Note text |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerTypeId":1,"ownerId":1,"itemType":1,"itemId":2,"text":"Test note"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.note.save
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerTypeId":1,"ownerId":1,"itemType":1,"itemId":2,"text":"Test note","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.note.save
try
{
const response = await $b24.callMethod(
'crm.timeline.note.save',
{
ownerTypeId: 1,
ownerId: 1,
itemType: 1,
itemId: 2,
text: 'Test note',
}
);
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.timeline.note.save',
[
'ownerTypeId' => 1,
'ownerId' => 1,
'itemType' => 1,
'itemId' => 2,
'text' => 'Test note',
]
);
$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 saving note: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.note.save",
{
ownerTypeId: 1,
ownerId: 1,
itemType: 1,
itemId: 2,
text: 'Test note',
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.note.save',
[
'ownerTypeId' => 1,
'ownerId' => 1,
'itemType' => 1,
'itemId' => 2,
'text' => 'Test note'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
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 |
Operation result |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "NOT_FOUND",
"error_description": "Element not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Insufficient permissions |
|
|
Element not found |
|
|
Required fields not provided |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |