BObox
Task assignments

Update task assignment

Changed on

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

put/task_assignments/{task_assignment_id}

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/task_assignments/{task_assignment_id}
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

task_assignment_idstring required

The ID of the task assignment.

Request body

messagestring

An optional message by the assignee that can be added to the task.

resolution_state'completed' | 'incomplete' | 'approved' | 'rejected'

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.

Example request

{
  "message": "Looks good to me",
  "resolution_state": "completed"
}

Response

Returns the updated task assignment object.

idstring

The unique identifier for this task assignment.

type'task_assignment'

The value will always be task_assignment.

messagestring

A message that will is included with the task assignment. This is visible to the assigned user in the web and mobile UI.

completed_atstring date-time

The date at which this task assignment was completed. This will be null if the task is not completed yet.

assigned_atstring date-time

The date at which this task was assigned to the user.

reminded_atstring date-time

The date at which the assigned user was reminded of this task assignment.

resolution_state'completed' | 'incomplete' | 'approved' | 'rejected'

The current state of the assignment. The available states depend on the action value of the task object.

Example response

{
  "id": "11446498",
  "type": "task_assignment",
  "item": {
    "id": "12345",
    "etag": "1",
    "type": "file",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  },
  "assigned_to": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "message": "Please review",
  "completed_at": "2012-12-12T10:53:43-08:00",
  "assigned_at": "2012-12-12T10:53:43-08:00",
  "reminded_at": "2012-12-12T10:53:43-08:00",
  "resolution_state": "incomplete",
  "assigned_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  }
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status