Latest version
Assign task
Assigns a task to a user.
A task can be assigned to more than one user by creating multiple assignments.
Request
bearer [ACCESS_TOKEN]
application/json
Request Body
objectin body
The user to assign the task to.
stringin bodyrequired
"3242343"The ID of the user to assign to the task.
To specify a user by their email
address use the login parameter.
stringin bodyrequired
"john@example.com"The email address of the user to assign to the task.
To specify a user by their user ID please use the id parameter.
objectin body
The task to assign to a user.
stringin bodyrequired
"11446498"The ID of the task
stringin bodyrequired
"task"The type of the item to assign.
Value is always task
Response
application/jsonTask assignment
Returns a new task assignment object.
application/jsonClient error
Returns an error if a change is attempted for a completed task or the user does not have access to the item linked to the task for the given task assignment.
application/jsonClient error
Returns an error when the task cannot be found.
application/jsonClient error
Returns an error if any of the IDs for this request were not valid, or if the targeted user does not have access to the file.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X POST "https://api.box.com/2.0/task_assignments" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"task": {
"id": "11446498",
"type": "task"
},
"assign_to": {
"id": "4823213"
}
}'TypeScript Gen
await client.taskAssignments.createTaskAssignment({
task: new CreateTaskAssignmentRequestBodyTaskField({
type: 'task' as CreateTaskAssignmentRequestBodyTaskTypeField,
id: task.id!,
}),
assignTo: {
id: currentUser.id,
} satisfies CreateTaskAssignmentRequestBodyAssignToField,
} satisfies CreateTaskAssignmentRequestBody);Python Gen
client.task_assignments.create_task_assignment(
CreateTaskAssignmentTask(
type=CreateTaskAssignmentTaskTypeField.TASK.value, id=task.id
),
CreateTaskAssignmentAssignTo(id=current_user.id),
).NET Gen
await client.TaskAssignments.CreateTaskAssignmentAsync(requestBody: new CreateTaskAssignmentRequestBody(task: new CreateTaskAssignmentRequestBodyTaskField(type: CreateTaskAssignmentRequestBodyTaskTypeField.Task, id: NullableUtils.Unwrap(task.Id)), assignTo: new CreateTaskAssignmentRequestBodyAssignToField() { Id = currentUser.Id }));Java
BoxUser user = new BoxUser(api, "user-id")
BoxTask task = new BoxTask(api, "id");
task.addAssignment(user);Python
user = client.user(user_id='11111')
assignment = client.task(task_id='12345').assign(user)
print(f'Assignment ID is {assignment.id} and is assigned to user {assignment.assigned_to.name}').NET
// Assign task 11111 to user 22222
var assignmentParams = new BoxTaskAssignmentRequest()
{
Task = new BoxTaskRequest()
{
Id = "11111"
},
AssignTo = new BoxAssignmentRequest()
{
Id = "22222"
}
};
BoxTaskAssignment assignment = await client.TasksManager.CreateTaskAssignmentAsync(assignmentParams);Node
// Assign task 11111 to user 22222
var taskID = '11111';
var userID = '22222';
client.tasks.assignByUserID(taskID, userID)
.then(assignment => {
/* assignment -> {
type: 'task_assignment',
id: '12345',
item:
{ type: 'file',
id: '33333',
sequence_id: '0',
etag: '0',
sha1: '7840095ee096ee8297676a138d4e316eabb3ec96',
name: 'script.js' },
assigned_to:
{ type: 'user',
id: '22222',
name: 'Sample Assignee',
login: 'assignee@exmaple.com' },
message: null,
completed_at: null,
assigned_at: '2013-05-10T11:43:41-07:00',
reminded_at: null,
resolution_state: 'incomplete',
assigned_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' } }
*/
});Response Example
{
"id": "11446498",
"type": "task_assignment",
"assigned_at": "2012-12-12T10:53:43-08:00",
"assigned_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"assigned_to": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"completed_at": "2012-12-12T10:53:43-08:00",
"item": {
"id": "12345",
"type": "file",
"etag": "1",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"name": "Contract.pdf",
"sequence_id": "3",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
},
"message": "Please review",
"reminded_at": "2012-12-12T10:53:43-08:00",
"resolution_state": "incomplete"
}