Update System CRM Activity crm.activity.update
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: any user with permission to update the activity
DEPRECATED
Development of this method has been halted. Please use crm.activity.todo.update.
The method crm.activity.update updates an existing activity.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Integer identifier of the activity in the timeline, for example |
|
fields* |
Array of values for activity fields in the following structure:
|
Parameter fields
Required parameters are marked with *
|
Field |
Description |
|
OWNER_ID* |
Identifier of the CRM object |
|
OWNER_TYPE_ID* |
|
|
TYPE_ID* |
Type of the activity |
|
ASSOCIATED_ENTITY_ID |
Identifier of the entity associated with the activity |
|
COMMUNICATIONS* |
|
|
DEADLINE |
Date and time of the activity deadline. This field is not set directly; the value is taken from START_TIME for calls and meetings, and from END_TIME for tasks |
|
DESCRIPTION |
Text description of the activity |
|
DESCRIPTION_TYPE |
Type of description |
|
DIRECTION |
Direction of the activity: incoming/outgoing. Relevant for calls and emails, not used for meetings |
|
END_TIME |
End time of the activity |
|
FILES |
Files added to the activity |
|
LOCATION |
Location |
|
NOTIFY_TYPE |
Type of notification |
|
ORIGINATOR_ID |
Identifier of the data source, used only for linking to an external source |
|
ORIGIN_ID |
Identifier of the entity in the data source, used only for linking to an external source |
|
ORIGIN_VERSION |
Original version, used to protect data from accidental overwriting by an external system. If the data was imported and not modified in the external system, it can be edited in CRM without fear that the next export will overwrite the data |
|
PRIORITY |
Priority |
|
PROVIDER_DATA |
Additional provider data |
|
PROVIDER_GROUP_ID |
Identifier of the provider group |
|
PROVIDER_ID |
Identifier of the provider |
|
PROVIDER_TYPE_ID |
Identifier of the provider type, status from the directory |
|
PROVIDER_PARAMS |
Additional provider parameters |
|
RESPONSIBLE_ID* |
Identifier of the user responsible for the activity |
|
SETTINGS |
Additional settings |
|
START_TIME |
Start time of the activity |
|
STATUS |
Status of the activity |
|
SUBJECT |
Additional description of the activity |
|
WEBDAV_ELEMENTS |
Added files. Deprecated, retained for compatibility |
|
IS_INCOMING_CHANNEL |
Flag indicating whether the activity was created from an incoming channel ( |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"fields":{"RESPONSIBLE_ID":1,"DESCRIPTION":"New description of the activity"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"fields":{"RESPONSIBLE_ID":1,"DESCRIPTION":"New description of the activity"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.update
// 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.activity.update',
params: {
id: 999,
fields: {
RESPONSIBLE_ID: 1,
DESCRIPTION: 'New activity description',
},
},
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('Activity updated successfully:', 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 updateActivity() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.update',
params: {
id: 999,
fields: {
RESPONSIBLE_ID: 1,
DESCRIPTION: 'New activity description',
},
},
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('Activity updated successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateActivity)
</script>
from datetime import datetime, timedelta
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.update(
bitrix_id=999,
fields={
"SUBJECT": "Updated follow-up",
"DEADLINE": (datetime.now() + timedelta(days=1)).isoformat(timespec="seconds"),
"DESCRIPTION": "Updated activity description",
"RESPONSIBLE_ID": 1,
"COMPLETED": "N",
},
).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.activity.update',
[
'id' => 999,
'fields' => [
"RESPONSIBLE_ID" => 1,
"DESCRIPTION" => "New description of the activity"
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating activity: ' . $e->getMessage();
}
BX24.callMethod(
'crm.activity.update',
{
id: 999,
fields: {
"RESPONSIBLE_ID": 1,
"DESCRIPTION": "New description of the activity"
}
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.update',
[
'id' => 999,
'fields' => [
'RESPONSIBLE_ID' => 1,
'DESCRIPTION' => 'New description of the activity'
]
]
);
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.activity.update", b24.Params{
"id": 999,
"fields": b24.Params{
"RESPONSIBLE_ID": 1,
"DESCRIPTION": "New description of the activity",
},
})
if err != nil {
return fmt.Errorf("crm.activity.update: %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 |
Result of the operation. Returns |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Access denied."
}
|
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
|
Code |
Description |
|
|
The activity with the specified identifier was not found for the entity in CRM |
|
|
The |
|
|
The |
|
|
The |
|
|
The |
|
|
More than one contact is specified |
|
|
Connections for the activity are not specified |
|
|
The activity type is not supported in the specified context |
|
|
Incorrect method call for configurable activity |
|
|
No permission to update the entity in CRM |
|
|
Incorrect |
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 |