Change a queue

PATCH

/api/v1/storage/queues/{queue}

curl --request PATCH \
  --url https://digize.com/api/v1/storage/queues/example \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "paused": true, "deadLetterQueue": "example", "consumer": { "batchSize": 1, "maxWaitSeconds": 1, "maxRetries": 1, "maxConcurrency": 1 } }'

• Digize

Pauses or resumes delivery, changes the dead-letter queue, or changes the consumer’s batch size, wait, retries and concurrency.

Needs the sites:write permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

queue

required

string

>= 1 characters <= 100 characters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

paused

boolean

deadLetterQueue

string | null

consumer

object

batchSize

integer

>= 1 <= 100

maxWaitSeconds

number

<= 60

maxRetries

integer

<= 100

maxConcurrency

Any of:

integer

integer

>= 1 <= 250

null

null

Example ^generated

{
  "paused": true,
  "deadLetterQueue": "example",
  "consumer": {
    "batchSize": 1,
    "maxWaitSeconds": 1,
    "maxRetries": 1,
    "maxConcurrency": 1
  }
}

Responses

200

Done

Media typeapplication/json

object

id

required

string

name

required

string

cloudflareName

required

string

createdAt

required

string format: date-time

deadLetterQueue

required

string | null

producers

required

Array<object>

object

worker

required

string

variable

required

string | null

consumer

required

Any of:

object

object

worker

required

string

bindingId

required

string

batchSize

required

number

maxWaitSeconds

required

number

maxRetries

required

number

maxConcurrency

required

number | null

set

required

boolean

null

null

deadLetterFor

required

string | null

backlog

required

number

perMinute

required

number

paused

required

boolean

hours

required

Array<object>

object

at

required

string format: date-time

published

required

number

delivered

required

number

failed

required

number

live

required

boolean

Example ^generated

{
  "id": "example",
  "name": "example",
  "cloudflareName": "example",
  "createdAt": "2026-04-15T12:00:00Z",
  "deadLetterQueue": "example",
  "producers": [
    {
      "worker": "example",
      "variable": "example"
    }
  ],
  "consumer": {
    "worker": "example",
    "bindingId": "example",
    "batchSize": 1,
    "maxWaitSeconds": 1,
    "maxRetries": 1,
    "maxConcurrency": 1,
    "set": true
  },
  "deadLetterFor": "example",
  "backlog": 1,
  "perMinute": 1,
  "paused": true,
  "hours": [
    {
      "at": "2026-04-15T12:00:00Z",
      "published": 1,
      "delivered": 1,
      "failed": 1
    }
  ],
  "live": true
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}