tools.ozone.queue.createQueue

ozone-lexicons.bsky.social

Documentation

Create a new moderation queue. A queue can have optional matching criteria that ozone's queue router will use to match reports. A queue with no criteria must have reports assigned to it manually via (1) `modTool.meta.queueId` in `tools.ozone.moderation.emitEvent` or (2) `tools.ozone.report.reassignQueue`.

main procedure

Create a new moderation queue. A queue can have optional matching criteria that ozone's queue router will use to match reports. A queue with no criteria must have reports assigned to it manually via (1) `modTool.meta.queueId` in `tools.ozone.moderation.emitEvent` or (2) `tools.ozone.report.reassignQueue`.

Input

Encodingapplication/json
collection stringnsid Optional

Collection name for record subjects. Required if subjectTypes includes 'record'.

description string Optional

Optional description of the queue

name string Required

Display name for the queue (must be unique)

recommendedLabels array Optional

Labels to recommend for this queue and use as fallback appeal routing mappings

recommendedPolicies array Optional

Policy keys to recommend when actioning reports in this queue

reportTypes array Optional

Report reason types (fully qualified NSIDs)

maxLength: 25 items
subjectTypes array Optional

Subject types this queue accepts

Output

Encodingapplication/json

Errors

InvalidRecommendedPolicies One or more recommended policy keys do not exist in the configured policy list
ConflictingQueue The queue configuration conflicts with an existing queue
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Create a new moderation queue. A queue can have optional matching criteria that ozone's queue router will use to match reports. A queue with no criteria must have reports assigned to it manually via (1) `modTool.meta.queueId` in `tools.ozone.moderation.emitEvent` or (2) `tools.ozone.report.reassignQueue`.",
  "errors": [
    {
      "description": "One or more recommended policy keys do not exist in the configured policy list",
      "name": "InvalidRecommendedPolicies"
    },
    {
      "description": "The queue configuration conflicts with an existing queue",
      "name": "ConflictingQueue"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "collection": {
          "description": "Collection name for record subjects. Required if subjectTypes includes 'record'.",
          "format": "nsid",
          "type": "string"
        },
        "description": {
          "description": "Optional description of the queue",
          "type": "string"
        },
        "name": {
          "description": "Display name for the queue (must be unique)",
          "type": "string"
        },
        "recommendedLabels": {
          "description": "Labels to recommend for this queue and use as fallback appeal routing mappings",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "recommendedPolicies": {
          "description": "Policy keys to recommend when actioning reports in this queue",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "reportTypes": {
          "description": "Report reason types (fully qualified NSIDs)",
          "items": {
            "type": "string"
          },
          "maxLength": 25,
          "type": "array"
        },
        "subjectTypes": {
          "description": "Subject types this queue accepts",
          "items": {
            "knownValues": [
              "account",
              "record",
              "message",
              "conversation"
            ],
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "name"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "queue": {
          "ref": "tools.ozone.queue.defs#queueView",
          "type": "ref"
        }
      },
      "required": [
        "queue"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@