---
title: "PUT /api/v1/project/task-queues/{id}/"
method: PUT
path: "/api/v1/project/task-queues/{id}/"
tags: ["project", "v1"]
---

# PUT /api/v1/project/task-queues/{id}/

`PUT /api/v1/project/task-queues/{id}/`

Update Task Queue

    PUT params:
        - pk: int
        - description: str
        - documents: list[int]
        - completed_documents: list[int]
        - reviewers: list[int]
    Optional params for add/remove document from/to a TaskQueue:
        - add_document: int
        - remove_document: int
    Optional params for complete/reopen document in a TaskQueue:
        - complete_document: int
        - open_document: int
    Optional param to add documents from DocumentCluster:
        - add_documents_from_cluster: int (cluster id)

## Path parameters

- `id` string, required

## Request body

- TaskQueue
  - `pk` integer
  - `description` string, nullable
  - `documents` integer[]
  - `documents_data` TaskQueueDocumentsDataInner[]
    - `pk` integer
    - `name` string, nullable
    - `description` string, nullable
    - `document_type` string, nullable
  - `completed_documents` integer[]
  - `completed_documents_data` TaskQueueDocumentsDataInner[]
    - `pk` integer
    - `name` string, nullable
    - `description` string, nullable
    - `document_type` string, nullable
  - `reviewers` integer[]
  - `reviewers_data` TaskQueueReviewersDataInner[]
    - `pk` integer
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
  - `progress` string
  - `data` string

## Response `200`

- TaskQueue
  - `pk` integer
  - `description` string, nullable
  - `documents` integer[]
  - `documents_data` TaskQueueDocumentsDataInner[]
    - `pk` integer
    - `name` string, nullable
    - `description` string, nullable
    - `document_type` string, nullable
  - `completed_documents` integer[]
  - `completed_documents_data` TaskQueueDocumentsDataInner[]
    - `pk` integer
    - `name` string, nullable
    - `description` string, nullable
    - `document_type` string, nullable
  - `reviewers` integer[]
  - `reviewers_data` TaskQueueReviewersDataInner[]
    - `pk` integer
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
  - `progress` string
  - `data` string

---

[API](https://skmtc.net/lexpredict/apis/contraxsuite-api.md) · [All operations](https://skmtc.net/lexpredict/apis/contraxsuite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lexpredict/contraxsuite-api/revisions/3429f921b4cb/schema)