Update Color of Universal Activity crm.activity.todo.updateColor
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 edit access permission for the CRM object to which the activity is linked
The method crm.activity.todo.updateColor updates the color of a universal activity.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the activity being updated, for example You can retrieve the identifier using the crm.activity.list method with the filter |
|
ownerTypeId* |
Identifier of the CRM object type in whose timeline the activity is located, for example |
|
ownerId* |
Identifier of the CRM entity in whose timeline the activity is located, for example The |
|
colorId* |
Identifier of the new color of the activity in the timeline. Pass the value as a string, for example
If the value is not in the list, the method returns the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"ownerTypeId":2,"ownerId":1,"colorId":"3"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.todo.updateColor
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"ownerTypeId":2,"ownerId":1,"colorId":"3","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.todo.updateColor
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type UpdateColorResult = {
id: number
}
try {
const response = await $b24.actions.v2.call.make<UpdateColorResult>({
method: 'crm.activity.todo.updateColor',
params: {
id: 999,
ownerTypeId: 2,
ownerId: 1,
colorId: '3',
},
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('Updated todo color, activity id:', result.id)
}
} 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 updateTodoColor() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.todo.updateColor',
params: {
id: 999,
ownerTypeId: 2,
ownerId: 1,
colorId: '3',
},
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('Updated todo color, activity id:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateTodoColor)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.todo.update_color(
bitrix_id=999,
owner_type_id=2,
owner_id=1,
color_id="3",
).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.todo.updateColor',
[
'id' => 999,
'ownerTypeId' => 2,
'ownerId' => 1,
'colorId' => '3',
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
"crm.activity.todo.updateColor",
{
id: 999,
ownerTypeId: 2,
ownerId: 1,
colorId: '3'
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.todo.updateColor',
[
'id' => 999,
'ownerTypeId' => 2,
'ownerId' => 1,
'colorId' => '3'
]
);
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.todo.updateColor", b24.Params{
"id": 999,
"ownerTypeId": 2,
"ownerId": 1,
"colorId": "3",
})
if err != nil {
return fmt.Errorf("crm.activity.todo.updateColor: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID)
Response Handling
HTTP status: 200
{
"result": {
"id": 999
},
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+02:00",
"date_finish": "2025-01-21T13:47:08+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the identifier of the updated activity (detailed description) |
|
time |
Information about the execution time of the request |
Object result
|
Name |
Description |
|
id |
Identifier of the updated activity, matches the passed |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Invalid color value."
}
|
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 |
|
|
|
Could not find value for parameter |
The required parameter |
|
|
|
Item was not found |
No activity with this |
|
|
|
Invalid value {3} to match with parameter {colorId}. Should be value of type string. |
The |
|
|
|
Invalid color value |
The |
|
|
|
Cannot change color for closed activity |
The activity is closed and cannot be updated |
|
|
|
Access denied |
The user does not have permission to edit the CRM entity |
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
- Universal CRM Activities: Overview of Methods
- Add Universal Activity crm.activity.todo.add
- Update Universal Activity crm.activity.todo.update
- Update Deadline for Universal Activity crm.activity.todo.updateDeadline
- Update the description of the universal activity crm.activity.todo.updateDescription
- Update the responsible user for the universal activity crm.activity.todo.updateResponsibleUser
- Get information about the activity by ID crm.activity.get
- Get List of Activities crm.activity.list
- Delete activity crm.activity.delete