tasks.task.pin — метод REST API Битрикс24

Описание

Метод tasks.task.pin закрепляет задачу в списке задач текущего пользователя.

Параметры

id integer обязательный

Идентификатор задачи.

Идентификатор задачи можно получить при создании новой задачи или методом получения списка задач

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":3897}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.task.pin

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":3897,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.task.pin

// 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, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type TaskPinResult = {
  task: {
    id: string
    title: string
    status: string
    isPinned: string
    createdDate: ISODate | null
    deadline: ISODate | null
  }
}

try {
  const response = await $b24.actions.v2.call.make<TaskPinResult>({
    method: 'tasks.task.pin',
    params: {
      id: 3897,
    },
    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('Pinned task:', result.task.id, result.task.title, result.task.isPinned)
  }
} 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 pinTask() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'tasks.task.pin',
        params: {
          id: 3897,
        },
        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('Pinned task:', result.task.id, result.task.title, result.task.isPinned)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', pinTask)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.tasks.task.pin(
        bitrix_id=3897,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'tasks.task.pin',
            [
                'id' => 3897
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error pinning task: ' . $e->getMessage();
}

BX24.callMethod(
    'tasks.task.pin',
    {
        'id': 3897
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);

require_once('crest.php');

$result = CRest::call(
    'tasks.task.pin',
    [
        'id' => 3897
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.task.pin", b24.Params{
	"id": 3897,
})
if err != nil {
	return fmt.Errorf("tasks.task.pin: %w", err)
}

// Метод заворачивает ответ в объект с ключом "task".
raw, ok := b24.Unwrap(res.Result, "task")
if !ok {
	return fmt.Errorf("в ответе нет ключа task")
}

var item struct {
	ID          b24.ID `json:"id"`
	Title       string `json:"title"`
	Description string `json:"description"`
	Priority    string `json:"priority"`
	Multitask   string `json:"multitask"`
	NotViewed   string `json:"notViewed"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Title)

Ответ

HTTP-статус: 200

{
    "result": {
        "task": {
            "id": "3897",
            "parentId": null,
            "title": "Пример задачи",
            "description": "",
            "mark": null,
            "priority": "1",
            "multitask": "N",
            "notViewed": "N",
            "replicate": "N",
            "stageId": "0",
            "sprintId": null,
            "backlogId": null,
            "createdBy": "503",
            "createdDate": "2026-05-21T11:50:16+03:00",
            "responsibleId": "503",
            "changedBy": "503",
            "changedDate": "2026-05-21T11:50:16+03:00",
            "statusChangedBy": null,
            "closedBy": null,
            "closedDate": null,
            "activityDate": "2026-05-21T11:50:16+03:00",
            "dateStart": null,
            "deadline": "2026-05-26T22:00:00+03:00",
            "startDatePlan": null,
            "endDatePlan": null,
            "guid": "{b3757070-422d-4221-82bd-ed1b8ec26c35}",
            "xmlId": null,
            "commentsCount": null,
            "serviceCommentsCount": null,
            "allowChangeDeadline": "N",
            "allowTimeTracking": "N",
            "taskControl": "N",
            "addInReport": "N",
            "forkedByTemplateId": null,
            "timeEstimate": "0",
            "timeSpentInLogs": null,
            "matchWorkTime": "N",
            "forumTopicId": null,
            "forumId": null,
            "siteId": "s1",
            "subordinate": "N",
            "exchangeModified": null,
            "exchangeId": null,
            "outlookVersion": "1",
            "viewedDate": null,
            "sorting": null,
            "durationFact": null,
            "isMuted": "N",
            "isPinned": "Y",
            "isPinnedInGroup": "N",
            "flowId": null,
            "chatId": 3619,
            "descriptionInBbcode": "Y",
            "status": "2",
            "statusChangedDate": "2026-05-21T11:50:16+03:00",
            "durationPlan": null,
            "durationType": "days",
            "favorite": "N",
            "groupId": "0",
            "auditors": [],
            "accomplices": [],
            "checklist": [],
            "group": [],
            "creator": {
                "id": "503",
                "name": "Мария Иванова",
                "link": "/company/personal/user/503/",
                "icon": "https://mysite.ru/path/to/avatar.png",
                "workPosition": null
            },
            "responsible": {
                "id": "503",
                "name": "Мария Иванова",
                "link": "/company/personal/user/503/",
                "icon": "https://mysite.ru/path/to/avatar.png",
                "workPosition": null
            },
            "accomplicesData": [],
            "auditorsData": [],
            "newCommentsCount": 0,
            "action": {
                "accept": false,
                "decline": false,
                "complete": true,
                "approve": false,
                "disapprove": false,
                "start": true,
                "pause": false,
                "delegate": true,
                "remove": true,
                "edit": true,
                "defer": true,
                "renew": false,
                "create": true,
                "changeDeadline": true,
                "checklistAddItems": true,
                "addFavorite": true,
                "deleteFavorite": false,
                "rate": true,
                "take": false,
                "edit.originator": false,
                "checklist.reorder": true,
                "elapsedtime.add": true,
                "dayplan.timer.toggle": false,
                "edit.plan": true,
                "checklist.add": true,
                "favorite.add": true,
                "favorite.delete": false
            },
            "checkListTree": {
                "nodeId": 0,
                "fields": {
                    "id": null,
                    "copiedId": null,
                    "entityId": null,
                    "userId": 503,
                    "createdBy": null,
                    "parentId": null,
                    "title": "",
                    "sortIndex": null,
                    "displaySortIndex": "",
                    "isComplete": false,
                    "isImportant": false,
                    "completedCount": 0,
                    "members": [],
                    "attachments": [],
                    "nodeId": null
                },
                "action": [],
                "descendants": []
            },
            "checkListCanAdd": true
        }
    },
    "time": {
        "start": 1779353517,
        "finish": 1779353517.987214,
        "duration": 0.9872140884399414,
        "processing": 0,
        "date_start": "2026-05-21T11:51:57+03:00",
        "date_finish": "2026-05-21T11:51:57+03:00",
        "operating_reset_at": 1779354117,
        "operating": 0
    }
}

Возвращаемые данные

result object

Объект с данными ответа.

Возвращает пустой массив "result":[], если у пользователя нет доступа к задаче или задача с указанным id не существует

task object

Объект с описанием задачи после закрепления

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error":"0",
    "error_description":"wrong task id"
}

Код	Описание	Значение
`0`	wrong task id	В параметре `id` указано значение неверного типа
`100`	CTaskItem All parameters in the constructor must have real class type	Параметр `id` не передан