Update an annotation queue

Update fields on an existing annotation queue. Supports updating name, description, filters, enabled status, and adding/removing events.

PUT /v1/queues/{queue_id}

Update an annotation queue

cURL

curl --request PUT \
  --url https://api.dp1.us.honeyhive.ai/v1/queues/{queue_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "enabled": true,
  "add_event_ids": [
    "<string>"
  ],
  "remove_event_ids": [
    "<string>"
  ]
}
'

200

{
  "queue": {
    "name": "<string>",
    "description": "<string>",
    "filters": {
      "filterArray": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ]
    },
    "enabled": true,
    "id": "<string>",
    "scope_id": "<string>",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

queue_id · string · required

Annotation queue ID

Body

application/json

id · string · required

Minimum string length: 1

name · string

Maximum string length: 200

description · string

Maximum string length: 1000

filters · object

Show child attributes

enabled · boolean

add_event_ids · string[]

remove_event_ids · string[]

Response

200

application/json

Queue updated successfully

queue · object · required

Show child attributes

message · string · required