Add Universal Activity crm.activity.todo.add
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 edit the CRM entity to whose timeline the activity is being added
The method crm.activity.todo.add adds a universal activity to the timeline of a CRM entity.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ownerTypeId* |
Identifier of the CRM object type to whose timeline the activity is added, for example |
|
ownerId* |
Identifier of the CRM entity to whose timeline the activity is added, for example You can retrieve the identifier using the crm.item.list method |
|
deadline* |
Deadline for the activity in ISO 8601 format, for example If you do not specify a time zone, the time is interpreted in the time zone of the user on whose behalf the request is executed. If you pass only a date, for example |
|
title |
Title of the activity. Default is an empty string |
|
description |
Description of the activity. Supports BB code, for example |
|
responsibleId |
Identifier of the employee responsible for the activity, for example Only a company employee can be assigned as responsible. If the user is not found or is an external user, the method returns the By default, and also when the value is |
|
parentActivityId |
Identifier of the previous activity in the timeline, for example The new activity is linked to the previous one, and the previous activity is closed. If no activity with this identifier is found, the parameter is ignored |
|
pingOffsets |
Array of integers: how many minutes before the deadline to send reminders. For example, The method discards negative and non-numeric values and merges duplicates. Default is an empty array, with no reminders |
|
colorId |
Identifier of the activity color in the timeline. Pass the value as a string, for example
If the parameter is not passed or the value is not in the list, the activity gets the default color. The method does not return an error for an invalid value |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerTypeId":2,"ownerId":1,"deadline":"'"$(date -Iseconds)"'","title":"Activity Title","description":"Activity Description","responsibleId":5,"pingOffsets":[0,15],"colorId":"2"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.todo.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerTypeId":2,"ownerId":1,"deadline":"'"$(date -Iseconds)"'","title":"Activity Title","description":"Activity Description","responsibleId":5,"pingOffsets":[0,15],"colorId":"2","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.todo.add
// 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 TodoAddResult = {
id: number
}
try {
const response = await $b24.actions.v2.call.make<TodoAddResult>({
method: 'crm.activity.todo.add',
params: {
ownerTypeId: 2,
ownerId: 1,
deadline: new Date().toISOString(),
title: 'Todo activity title',
description: 'Todo activity description',
responsibleId: 5,
pingOffsets: [0, 15],
colorId: '2',
},
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('Added todo 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 addTodoActivity() {
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.add',
params: {
ownerTypeId: 2,
ownerId: 1,
deadline: new Date().toISOString(),
title: 'Todo activity title',
description: 'Todo activity description',
responsibleId: 5,
pingOffsets: [0, 15],
colorId: '2',
},
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('Added todo activity ID:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addTodoActivity)
</script>
from datetime import datetime, timedelta
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.todo.add(
owner_type_id=2,
owner_id=1,
deadline=datetime.now() + timedelta(days=1),
title="Follow up with customer",
description="Discuss proposal details",
responsible_id=5,
ping_offsets=[0, 15],
color_id="2",
).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.add',
[
'ownerTypeId' => 2,
'ownerId' => 1,
'deadline' => (new DateTime())->format(DATE_ATOM),
'title' => 'Activity Title',
'description' => 'Activity Description',
'responsibleId' => 5,
'pingOffsets' => [0, 15],
'colorId' => '2'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your data processing logic
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding todo activity: ' . $e->getMessage();
}
BX24.callMethod(
"crm.activity.todo.add",
{
ownerTypeId: 2,
ownerId: 1,
deadline: new Date().toISOString(),
title: 'Activity Title',
description: 'Activity Description',
responsibleId: 5,
pingOffsets: [0, 15],
colorId: '2'
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.todo.add',
[
'ownerTypeId' => 2,
'ownerId' => 1,
'deadline' => date('c'), // Current date and time in ISO 8601 format
'title' => 'Activity Title',
'description' => 'Activity Description',
'responsibleId' => 5,
'pingOffsets' => [0, 15],
'colorId' => '2'
]
);
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.add", b24.Params{
"ownerTypeId": 2,
"ownerId": 1,
"deadline": time.Now().Format(time.RFC3339),
"title": "Activity Title",
"description": "Activity Description",
"responsibleId": 5,
"pingOffsets": []int{0, 15},
"colorId": "2",
})
if err != nil {
return fmt.Errorf("crm.activity.todo.add: %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 added activity (detailed description) |
|
time |
Information about the execution time of the request |
Object result
|
Name |
Description |
|
id |
Identifier of the added activity. Use it in the |
Error Handling
HTTP Status: 400
{
"error": "WRONG_DATETIME_FORMAT",
"error_description": "Incorrect date format."
}
|
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 |
|
|
|
Invalid value {3} to match with parameter {colorId}. Should be value of type string. |
The |
|
|
|
Incorrect date format |
The |
|
|
|
Item was not found |
A non-existent CRM object type is passed in |
|
|
|
Access denied |
The user does not have permission to edit the CRM entity |
|
|
|
The specified user cannot be assigned as responsible |
The user from |
|
|
|
Activity completion error text |
The activity is created, but the previous activity from |
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
- 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 Color of Universal Activity crm.activity.todo.updateColor
- 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
- Add a CRM Activity to a New Lead or Deal Depending on the CRM Mode