Make changes to an existing task
Make changes to an existing task
To update a task in Box you will need to call the
PUT /tasks/:task_id API with the ID of the task. This API
can be used to change the action type of the task, add a message, or change
the due date.
curl -i -X PUT "https://api.box.com/2.0/tasks/12345" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"action": "review"
}'await client.tasks.updateTaskById(task.id!, {
requestBody: {
message: 'updated message',
} satisfies UpdateTaskByIdRequestBody,
} satisfies UpdateTaskByIdOptionalsInput);client.tasks.update_task_by_id(task.id, message="updated message")await client.Tasks.UpdateTaskByIdAsync(taskId: NullableUtils.Unwrap(task.Id), requestBody: new UpdateTaskByIdRequestBody() { Message = "updated message" });try await client.tasks.updateTaskById(taskId: task.id!, requestBody: UpdateTaskByIdRequestBody(message: "updated message"))client.getTasks().updateTaskById(task.getId(), new UpdateTaskByIdRequestBody.Builder().message("updated message").build())await client.Tasks.UpdateTaskByIdAsync(taskId: NullableUtils.Unwrap(task.Id), requestBody: new UpdateTaskByIdRequestBody() { Message = "updated message" });await client.tasks.updateTaskById(task.id!, {
requestBody: {
message: 'updated message',
} satisfies UpdateTaskByIdRequestBody,
} satisfies UpdateTaskByIdOptionalsInput);Task actions
Box currently supports two types of tasks defined by the action value:
review tasks and complete tasks.
The type of task determines the possible resolution states a task can be in and the interface shown to a user in the web and mobile apps.
| Task action | Possible resolution states |
|---|---|
review | incomplete, approved, rejected |
complete | incomplete, complete |
A review task starts out in an incomplete state and can be marked as
incomplete, approved, or rejected. In the user interface a user is
provided with a text box and an pair of buttons to approve or reject the task.
A complete task starts out in an incomplete state and can be marked
incomplete or completed. Once a this task is marked completed, no
further changes can be made to the task's state. In the user interface a user is
provided with a text box and an button to mark the task as completed.
Completion rules
A task on a file can be assigned to more than one collaborator on the file, and
a task has a completion_rule that can be used to define if all users who've
been assigned the task (all_assignees) or only one assignee (any_assignee)
need to complete the task.