---
updatedAt: 2026-05-06T16:58:26.000Z
agentTools:
  projectIndex: https://cloud.docs.tamr.com/llms.txt
---

# create queue

Create a new queue.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Queues",
    "version": "v1alpha2"
  },
  "tags": [
    {
      "name": "tamr.api.queues.v1alpha2.Queues"
    }
  ],
  "paths": {
    "/api/v1alpha2/projects/{projectId}/queues": {
      "post": {
        "summary": "create queue",
        "description": "Create a new queue.",
        "operationId": "Queues_CreateQueue",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tamr.api.queues.v1alpha2.Queue"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "projectId",
            "description": "Required. The project to create the queue in.",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/tamr.api.queues.v1alpha2.Queues.CreateQueueBody"
              }
            }
          },
          "required": true
        },
        "tags": [
          "tamr.api.queues.v1alpha2.Queues"
        ]
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "X-API-KEY",
        "value": "example-api-key"
      }
    ]
  },
  "servers": [
    {
      "url": "https://api-examples.tamr.cloud"
    }
  ],
  "components": {
    "schemas": {
      "tamr.api.queues.v1alpha2.Queue": {
        "type": "object",
        "properties": {
          "queueId": {
            "type": "string",
            "description": "Output only. The unique identifier for the queue. Generated by the service on creation.",
            "readOnly": true
          },
          "projectId": {
            "type": "string",
            "description": "Output only. The project this queue belongs to.",
            "readOnly": true
          },
          "queueType": {
            "description": "Required. The type of queue items this queue accepts.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.queues.v1alpha2.QueueType"
              }
            ]
          },
          "name": {
            "type": "string",
            "description": "Optional. URL-friendly slug for the queue (6-30 characters, lowercase, alphanumeric with hyphens)."
          },
          "displayName": {
            "type": "string",
            "description": "Required. Human-readable display name for the queue."
          },
          "description": {
            "type": "string",
            "description": "Optional. Description of the queue's purpose."
          },
          "status": {
            "description": "Output only. The status of the queue.",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.queues.v1alpha2.QueueStatus"
              }
            ]
          },
          "createTime": {
            "type": "string",
            "format": "date-time",
            "description": "Output only. Time when the queue was created.",
            "readOnly": true
          },
          "updateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Output only. Time when the queue was last updated.",
            "readOnly": true
          },
          "tableIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Output only. The table IDs this queue is scoped to.\nReflects the tables resolved from the scopes provided at creation time.",
            "readOnly": true
          }
        },
        "required": [
          "queueType",
          "displayName"
        ]
      },
      "tamr.api.queues.v1alpha2.QueueScope": {
        "type": "object",
        "properties": {
          "tableId": {
            "type": "string",
            "description": "The external ID of a specific table (e.g. tbl_...)."
          },
          "dataProductId": {
            "type": "string",
            "description": "The external ID of a data product (e.g. dp_...). Resolved to all of\nthe data product's constituent tables at queue creation time."
          }
        },
        "description": "A scope filter restricting which records can generate events in a queue.\nResolved to table IDs at queue creation time (immutable after creation)."
      },
      "tamr.api.queues.v1alpha2.QueueStatus": {
        "type": "string",
        "enum": [
          "QUEUE_UNSPECIFIED",
          "QUEUE_ACTIVE",
          "QUEUE_PAUSED",
          "QUEUE_ARCHIVED"
        ],
        "default": "QUEUE_UNSPECIFIED",
        "description": " - QUEUE_UNSPECIFIED: Default value. This value is unused.\n - QUEUE_ACTIVE: Queue is active and accepting new items.\n - QUEUE_PAUSED: Queue is paused, and not accepting new items.\n - QUEUE_ARCHIVED: Queue is archived and not accepting new items."
      },
      "tamr.api.queues.v1alpha2.QueueType": {
        "type": "string",
        "enum": [
          "QUEUE_TYPE_UNSPECIFIED",
          "SUGGESTED_RECORD_EDIT",
          "SUGGESTED_DUPLICATE_RECORD",
          "SUGGESTED_RECORD_CLASSIFICATION"
        ],
        "default": "QUEUE_TYPE_UNSPECIFIED",
        "description": " - QUEUE_TYPE_UNSPECIFIED: Default value. This value is unused.\n - SUGGESTED_RECORD_EDIT: Queue for reviewing suggested record edits.\n - SUGGESTED_DUPLICATE_RECORD: Queue for reviewing suggested duplicate records.\n - SUGGESTED_RECORD_CLASSIFICATION: Queue for reviewing suggested record classifications."
      },
      "tamr.api.queues.v1alpha2.Queues.CreateQueueBody": {
        "type": "object",
        "properties": {
          "queue": {
            "description": "Required. Definition of the queue to create.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.queues.v1alpha2.Queue"
              }
            ]
          },
          "scopes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/tamr.api.queues.v1alpha2.QueueScope"
            },
            "description": "Optional. Restricts the queue to only accept events from the specified tables or data\nproducts. Data product IDs are resolved to their constituent tables at creation time.\nIf empty, the queue accepts events from all tables. Immutable after creation."
          }
        },
        "required": [
          "queue"
        ]
      }
    }
  }
}
```