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* |
Object containing the activity fields to update (detailed description). Example structure:
|
|
params |
Optional update parameters. The |
Parameter fields
Pass only the fields you need to change in fields. The full list of fields and their descriptions is available in crm.activity.fields. A field marked as required in the metadata does not need to be passed with every update.
Field behavior during updates:
|
Field |
Description |
|
OWNER_ID |
Identifier of the current CRM item. The value passed during an update is ignored |
|
OWNER_TYPE_ID |
Identifier of the current CRM object type. The value passed during an update is ignored |
|
TYPE_ID |
The activity type cannot be changed. The value passed is ignored |
|
ASSOCIATED_ENTITY_ID |
Read-only. The value passed is ignored |
|
COMMUNICATIONS |
Array of communications. If provided, it must contain a valid communication. An empty array or a list without valid communications causes an error |
|
COMPLETED |
Activity completion flag: |
|
DEADLINE |
Cannot be changed directly: the value passed is ignored |
|
FILES |
Array of files. For each file, pass an object with |
|
PROVIDER_ID |
The activity provider cannot be changed. The value passed is ignored |
|
RESPONSIBLE_ID |
Identifier of the responsible user. Not required for every update |
|
SUBJECT |
Activity subject. Not required for every update |
|
IS_INCOMING_CHANNEL |
Read-only. The value passed is ignored |
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",
"START_TIME": (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 |
Returns |
|
time |
Information about the request execution time |
Error Handling
For example, when id = 0, the method returns an error:
HTTP Status: 400
{
"error": "",
"error_description": "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 |
Meaning |
|
|
Empty value |
|
The activity identifier is missing or invalid |
|
|
Empty value |
|
The |
|
|
Empty value |
|
The |
|
|
Empty value |
|
The activity with the specified identifier was not found |
|
|
Empty value |
|
An empty |
|
|
Empty value |
|
Use |
|
|
Empty value |
|
No permission to update the current CRM item; for an app activity, the call was made by another app |
|
|
Empty value |
|
Updating an activity with the |
When accessing a nonexistent activity, the response may also contain empty error and error_description values with HTTP status 400.
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 |