Attach Files to a Task tasks.task.files.attach
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: task Creator or a user with access permission to edit the task.
The method tasks.task.files.attach adds a file from Drive to a task. The user must have read access to the file or higher.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
taskId* |
The identifier of the task to which the file needs to be attached. The task identifier can be obtained when creating a new task or by using the get task list method. |
|
fileId* |
The identifier of the file on Drive. You can obtain the file identifier in two ways. Use one of the file upload methods: Use one of the methods to get the list of files: |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"taskId":8017,"fileId":1065}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.task.files.attach
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"taskId":8017,"fileId":1065,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.task.files.attach
// 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 AttachFileResult = {
attachmentId: number
}
try {
const response = await $b24.actions.v2.call.make<AttachFileResult>({
method: 'tasks.task.files.attach',
params: {
taskId: 8017,
fileId: 1065,
},
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('Attachment ID:', result.attachmentId)
}
} 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 attachFile() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.task.files.attach',
params: {
taskId: 8017,
fileId: 1065,
},
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('Attachment ID:', result.attachmentId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', attachFile)
</script>
try {
$response = $b24Service
->core
->call(
'tasks.task.files.attach',
[
'taskId' => 8017,
'fileId' => 1065
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error attaching file: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.task.files.attach',
{
taskId: 8017,
fileId: 1065
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.task.files.attach',
[
'taskId' => 8017,
'fileId' => 1065
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"attachmentId": 1079
},
"time": {
"start": 1758806783,
"finish": 1758806783.609955,
"duration": 0.6099550724029541,
"processing": 0,
"date_start": "2025-09-25T16:26:23+02:00",
"date_finish": "2025-09-25T16:26:23+02:00",
"operating_reset_at": 1758807383,
"operating": 0.4156019687652588
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response. Contains an object describing the attached file |
|
attachmentId |
The identifier of the file attachment to the task. You can get file data by the attachment identifier using the disk.attachedObject.get method |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "100",
"error_description": "Could not find value for parameter {fileId} (internal error)"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
CTaskItem All parameters in the constructor must have real class type (internal error) |
Required parameter |
|
|
wrong task id (internal error) |
The value of |
|
|
Could not find value for parameter {fileId} (internal error) |
Required parameter |
|
|
Invalid value {value} to match with parameter {fileId}. Should be value of type int. (internal error) |
The value of |
|
|
Insufficient permissions.\u003Cbr\u003E |
No access to the specified file |
|
|
Access denied (internal error) |
Insufficient permissions to modify the task |
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 permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |