Add Task tasks.task.add
Scope:
taskWho can execute the method: any user
The method tasks.task.add adds a new task.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Task fields. To create a task, fill in the required fields; without them, the creation operation will not be executed. |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
title* |
Task title |
|
creatorId* |
Creator's identifier. |
|
responsibleId* |
Executor's identifier. |
Code Examples
How to Use Examples in Documentation
The call to the new API differs by adding the parameter /api/ in the request:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/tasks.task.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"Task Title","deadline":"2025-12-31T23:59:59+02:00","creatorId":29,"responsibleId":1,"crmItemIds":["L_1000959"]}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/tasks.task.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"Task Title","deadline":"2025-12-31T23:59:59+02:00","creatorId":29,"responsibleId":1,"crmItemIds":["L_1000959"]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/tasks.task.add
The SDK does not yet support calls to the address /rest/api/. Use direct HTTP requests, for example, via curl or fetch.
try
{
const response = await $b24.callMethod(
'tasks.task.add',
{
fields: {
title: 'Task Title',
deadline: '2025-12-31T23:59:59+02:00',
creatorId: 29,
responsibleId: 1,
crmItemIds: ['L_1000959']
}
}
);
const result = response.getData().result;
console.info('Task created with ID', result.item?.id);
}
catch( error )
{
console.error(error);
}
The SDK does not yet support calls to the address /rest/api/. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'tasks.task.add',
[
'fields' => [
'title' => 'Task Title',
'deadline' => '2025-12-31T23:59:59+02:00',
'creatorId' => 29,
'responsibleId' => 1,
'crmItemIds' => ['L_1000959'],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating task: ' . $e->getMessage();
}
The SDK does not yet support calls to the address /rest/api/. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'tasks.task.add',
{
fields: {
title: 'Task Title',
deadline: '2025-12-31T23:59:59+02:00',
creatorId: 29,
responsibleId: 1,
crmItemIds: ['L_1000959']
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
The SDK does not yet support calls to the address /rest/api/. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'tasks.task.add',
[
'fields' => [
'title' => 'Task Title',
'deadline' => '2025-12-31T23:59:59+02:00',
'creatorId' => 29,
'responsibleId' => 1,
'crmItemIds' => ['L_1000959']
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"item": {
"id": 3839,
"title": "Task Title",
"description": "",
"deadline": "2026-01-01T00:59:59+03:00",
"needsControl": false,
"startPlan": null,
"endPlan": null,
"fileIds": null,
"checklist": [],
"epicId": null,
"storyPoints": null,
"priority": "average",
"status": "pending",
"statusChanged": null,
"parentId": null,
"containsChecklist": false,
"containsSubTasks": false,
"containsRelatedTasks": false,
"containsGanttLinks": false,
"containsPlacements": true,
"containsResults": false,
"numberOfReminders": 0,
"chatId": 2603,
"plannedDuration": 0,
"actualDuration": 0,
"durationType": "days",
"started": null,
"estimatedTime": 0,
"replicate": false,
"changed": "2025-12-11T12:25:33+03:00",
"closed": null,
"activity": "2025-12-11T12:25:33+03:00",
"guid": "{13d2c44c-730e-45dd-b99c-fdaad4e3c1fa}",
"xmlId": null,
"exchangeId": null,
"exchangeModified": null,
"outlookVersion": 1,
"mark": "none",
"allowsChangeDeadline": false,
"allowsTimeTracking": false,
"matchesWorkTime": false,
"addInReport": null,
"isMultitask": false,
"siteId": "s1",
"deadlineCount": null,
"declineReason": null,
"forumTopicId": null,
"link": "\/company\/personal\/user\/1\/tasks\/task\/view\/3839\/",
"rights": {
"read": true,
"watch": true,
"mute": true,
"createResult": true,
"edit": true,
"remove": true,
"complete": true,
"approve": false,
"disapprove": false,
"start": true,
"take": false,
"delegate": true,
"defer": true,
"renew": false,
"deadline": true,
"datePlan": true,
"changeDirector": false,
"changeResponsible": true,
"changeAccomplices": true,
"pause": false,
"timeTracking": false,
"mark": true,
"changeStatus": true,
"reminder": true,
"addAuditors": true,
"elapsedTime": true,
"favorite": true,
"checklistAdd": true,
"checklistEdit": true,
"checklistSave": true,
"checklistToggle": true,
"automate": true,
"resultEdit": false,
"completeResult": true,
"removeResult": false,
"resultRead": false,
"admin": true,
"createSubtask": true,
"copy": true,
"saveAsTemplate": true,
"attachFile": true,
"detachFile": true,
"detachParent": true,
"createGanttDependence": true,
"sort": false
},
"archiveLink": "\/bitrix\/tools\/disk\/uf.php?entityId=3839\u0026entity=TASKS_TASK\u0026fieldName=UF_TASK_WEBDAV_FILES\u0026signature=89f4f46e33905bcb0899c8cb9613a62cf8e104b182824e799d2aeb9d1e5bf526\u0026action=downloadArchiveByEntity\u0026ncc=1",
"crmItemIds": [
"L_1000959"
],
"requireResult": false,
"matchesSubTasksTime": false,
"autocompleteSubTasks": false,
"allowsChangeDatePlan": false,
"maxDeadlineChangeDate": null,
"maxDeadlineChanges": null,
"requireDeadlineChangeReason": false,
"inFavorite": [],
"inPin": [],
"inGroupPin": [],
"inMute": [],
"dependsOn": [],
"scenarios": [
"default"
]
}
},
"time": {
"start": 1765445133,
"finish": 1765445134.139558,
"duration": 1.1395580768585205,
"processing": 1,
"date_start": "2025-12-11T12:25:33+03:00",
"date_finish": "2025-12-11T12:25:34+03:00",
"operating_reset_at": 1765445733,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
item |
Object with task field values. Description of task fields with related objects |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating the request object",
"validation": [
{
"message": "The `deadline` field requires a `DateTime` data type for this request",
"field": "deadline"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Required field |
Add the specified field to the request body |
|
|
The |
Ensure that the provided value is of the correct type |
|
|
The user specified in the "Executor" field was not found |
Specify the identifier of an existing user in the |
|
|
"" |
Specify the identifier of an existing user in the |
|
|
The task specified in the "Parent Task" field was not found |
Specify the identifier of an existing task in the |
|
|
The end date in the scheduling is earlier than the start date |
Specify an |
|
|
The scheduling indicates a task duration that is too long |
Reduce the date in the |
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 |
Continue Learning
- Update Task tasks.task.update
- Send Message to Task Chat tasks.task.chat.message.send
- Delete Task tasks.task.delete
- Attach Files to Task tasks.task.file.attach