Sample - Box Platform API
POST/task_assignments

Assign task

Assigns a task to a user.

A task can be assigned to more than one user by creating multiple assignments.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 body fields
taskobjectrequired
The task to assign to a user.
assign_toobjectrequired
The user to assign the task to.

5 status codes
201Returns a new task assignment object.
idstringoptional
The unique identifier for this task assignment.
typestringoptional
The value will always be `task_assignment`.
Allowed:task_assignment
itemobjectoptional
assigned_toobjectoptional
messagestringoptional
A message that will is included with the task assignment. This is visible to the assigned user in the web and mobile UI.
completed_atstringoptional
The date at which this task assignment was completed. This will be `null` if the task is not completed yet.
assigned_atstringoptional
The date at which this task was assigned to the user.
reminded_atstringoptional
The date at which the assigned user was reminded of this task assignment.
resolution_statestringoptional
The current state of the assignment. The available states depend on the `action` value of the task object.
Allowed:completedincompleteapprovedrejected
assigned_byobjectoptional
403Returns 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.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
404Returns an error when the task cannot be found.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
500Returns 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.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 403 is returned: 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. A 404 is returned: Returns an error when the task cannot be found. A 500 is returned: 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. Any other status is an error: An unexpected client error.