Sample - Box Platform API
PUT/task_assignments/{task_assignment_id}

Update task assignment

Updates a task assignment. This endpoint can be used to update the state of a task assigned to a user.

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

1 parameter · 2 body fields
task_assignment_idstringrequired
The ID of the task assignment.
messagestringoptional
An optional message by the assignee that can be added to the task.
resolution_statestringoptional
The state of the task assigned to the user. * For a task with an `action` value of `complete` this can be `incomplete` or `completed`. * For a task with an `action` of `review` this can be `incomplete`, `approved`, or `rejected`.
Allowed:completedincompleteapprovedrejected

4 status codes
200Returns the updated 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
400Returns an error if a resolution state is incompatible with the action type of the task.
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 assignment could not be found or the user does not have access to the file the task is assigned to.
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 400 is returned: Returns an error if a resolution state is incompatible with the action type of the task. A 404 is returned: Returns an error when the task assignment could not be found or the user does not have access to the file the task is assigned to. Any other status is an error: An unexpected client error.