Manage Applications

    Update task

    put
    https://api.box.com/2.0
    /tasks/:task_id

    Updates a specific task.

    Request

    application/json

    Path Parameters

    stringin pathrequired
    12345

    The ID of the task.

    Request Body

    stringin bodyrequired
    review

    Value is always "review"

    stringin bodyoptional
    all_assignees

    When a task is created with completion rule "all_assignees" (default), the task will only be considered completed when all assignees have completed the task. When a task is created with completion rule "any_assignee", the task will be considered completed when one assignee has completed the task.

    Value is one of "all_assignees", "any_assignee"

    string / date-timein bodyoptional
    2012-12-12T10:53:43-08:00

    When the task is due

    stringin bodyoptional
    Please review

    The message included with the task

    Response

    application/jsonTask

    Returns the updated task object

    application/jsonClient Error

    Returns an error if the task for the given ID does not exist or is inaccessible to your account.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X PUT https://api.box.com/2.0/tasks/12345 \
         -H "Authorization: Bearer <ACCESS_TOKEN>" \
         -H "Content-Type: application/json" \
         -d '{
           "action": "review"
         }'
    .NET
    var updates = new BoxTaskUpdateRequest()
    {
        Id = "22222",
        Message = "Could you please review this?"
    };
    BoxTask updatedTask = await client.TasksManager.UpdateTaskAsync(updates);
    Java
    BoxTask task = new BoxTask(api, "id");
    BoxTask.Info info = task.new Info();
    info.setMessage("An edited message.");
    task.updateInfo(info);
    Python
    task_update = {'message': 'New Message', 'due_at': '2014-04-03T11:09:43-10:00',}
    updated_task = client.task(task_id='12345').update_info(task_update)
    print('New task message is {1} and the new due time is {1}'.format{updated_task.message, updated_Task.due_at})
    Node
    client.tasks.update('11111', { message: 'Could you please review?' })
    	.then(task => {
    		/* task -> {
    			type: 'task',
    			id: '11111',
    			item: 
    			{ type: 'file',
    				id: '22222',
    				sequence_id: '0',
    				etag: '0',
    				sha1: '0bbd79a105c504f99573e3799756debba4c760cd',
    				name: 'box-logo.png' },
    			due_at: '2014-04-03T11:09:43-07:00',
    			action: 'review',
    			message: 'Could you please review?',
    			task_assignment_collection: { total_count: 0, entries: [] },
    			is_completed: false,
    			created_by: 
    			{ type: 'user',
    				id: '33333',
    				name: 'Example User',
    				login: 'user@example.com' },
    			created_at: '2013-04-03T11:12:54-07:00' }
    		*/
    	});

    Response Example

    {
      "id": 11446498,
      "type": "task",
      "item": {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf"
      },
      "due_at": "2012-12-12T10:53:43-08:00",
      "action": "review",
      "message": "Legal review",
      "task_assignment_collection": {
        "total_count": 5000,
        "limit": 1000,
        "offset": 2000,
        "order": [
          {
            "by": "type",
            "direction": "ASC"
          }
        ],
        "entries": [
          {
            "id": 11446498,
            "type": "task_assignment",
            "item": {
              "id": 12345,
              "etag": 1,
              "type": "file",
              "sequence_id": 3,
              "name": "Contract.pdf"
            },
            "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"
            }
          }
        ]
      },
      "is_completed": true,
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "completion_rule": "all_assignees"
    }