---
title: "Update an annotation queue"
method: PATCH
path: "/v2/annotation-queues/{annotation_queue_id}"
tags: ["Annotation Queues"]
---

# Update an annotation queue

`PATCH /v2/annotation-queues/{annotation_queue_id}`

Update an annotation queue by its ID. At least one field must be provided.

**Payload Requirements**
- At least one of `name`, `instructions`, `annotation_config_ids`, or `annotator_emails` must be provided
- `name` must be unique within the space (409 Conflict if duplicate)
- `annotation_config_ids` replaces all existing config associations; all configs must belong to the same space as the queue
- `annotator_emails` replaces all existing user assignments; all users must have active accounts

**Valid example**
```json
{
  "name": "Updated Review Queue",
  "annotation_config_ids": ["QW5ub3RhdGlvbkNvbmZpZzoxOmFCY0Q=", "QW5ub3RhdGlvbkNvbmZpZzoyOmFCY0Q="],
  "annotator_emails": ["reviewer@example.com"]
}
```

**Invalid example** (empty body — no fields provided)
```json
{}
```

<Note>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Note>

## Path parameters

- `annotation_queue_id` string, required — A universally unique identifier (base64-encoded opaque string).

## Request body

- UpdateAnnotationQueueRequest
  - `name` string — The name of the annotation queue. Must be unique within the space.
  - `instructions` string, nullable — The instructions for annotators working on this queue. Set to `null` to clear the instructions.
  - `annotation_config_ids` string[] — The full list of annotation config IDs to associate with this queue. This replaces all existing annotation config associations. All annotation configs must belong to the same space as the queue.
  - `annotator_emails` Email[] — The full list of user emails to assign to this queue. This replaces all existing user assignments. All users must have an active account and access to the queue's space.

## Response `200`

An annotation queue object

- AnnotationQueue
  - `id` string, required — The unique identifier for the annotation queue
  - `name` string, required — The name of the annotation queue
  - `space_id` string, required — The space id the annotation queue belongs to
  - `instructions` string, nullable — The instructions for the annotation queue
  - `annotation_configs` AnnotationConfig[] — The annotation configs associated with this queue
    - union
      - object
        - `id` string, required — The unique identifier for the annotation config
        - `name` string, required — The name of the annotation config
        - `created_at` string, date-time, required — The timestamp for when the annotation config was created
        - `space_id` string, required — The space id the annotation config belongs to
        - `type` 'CONTINUOUS', required — Discriminator value identifying a continuous annotation config.
        - `minimum_score` number, double, required — The minimum score value
        - `maximum_score` number, double, required — The maximum score value
        - `optimization_direction` 'MAXIMIZE' | 'MINIMIZE' | 'NONE' — The direction for optimization. Defaults to `NONE` when omitted. - MAXIMIZE: higher scores are better - MINIMIZE: lower scores are better - NONE: higher or lower scores are neither better nor worse
      - object
        - `id` string, required — The unique identifier for the annotation config
        - `name` string, required — The name of the annotation config
        - `created_at` string, date-time, required — The timestamp for when the annotation config was created
        - `space_id` string, required — The space id the annotation config belongs to
        - `type` 'CATEGORICAL', required — Discriminator value identifying a categorical annotation config.
        - `values` CategoricalAnnotationValue[], required — An array of categorical annotation values
          - `label` string, required — The label value
          - `score` number, double — A score to associate with the label
        - `optimization_direction` 'MAXIMIZE' | 'MINIMIZE' | 'NONE' — The direction for optimization. Defaults to `NONE` when omitted. - MAXIMIZE: higher scores are better - MINIMIZE: lower scores are better - NONE: higher or lower scores are neither better nor worse
      - object
        - `id` string, required — The unique identifier for the annotation config
        - `name` string, required — The name of the annotation config
        - `created_at` string, date-time, required — The timestamp for when the annotation config was created
        - `space_id` string, required — The space id the annotation config belongs to
        - `type` 'FREEFORM', required — Discriminator value identifying a freeform annotation config.
  - `annotators` AnnotatorUser[], required — Users assigned as annotators to this queue
    - `id` string, required — The unique identifier for the user
    - `email` string, email, required — An email address
  - `created_at` string, date-time, required — The timestamp for when the annotation queue was created
  - `updated_at` string, date-time, required — The timestamp for when the annotation queue was last updated

## Other responses

- `400` — Invalid request
- `401` — Authentication is required
- `403` — Insufficient permissions to access this resource
- `404` — Not found
- `409` — Resource conflict
- `422` — Unprocessable entity
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/arize-ai/apis/arize-rest-api.md) · [All operations](https://skmtc.net/arize-ai/apis/arize-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arize-ai/arize-rest-api/versions/1e87d8a4cf69/schema)