Update Queue Consumer

PUT

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/workers/queues/{name}/consumers/{consumer_name}

Last modified:2022-12-16 13:48:34

Updates the consumer for a queue, or creates one if it does not exist.

Request

Path Params

consumer_name

string

required

name

string

required

account_identifier

string

required

Body Params application/json

optional

Example:

{"dead_letter_queue":"updated-example-dlq","environment":"production","script_name":"example-consumer","settings":{"batch_size":100}}

Example

{
    "dead_letter_queue": "updated-example-dlq",
    "environment": "production",
    "script_name": "example-consumer",
    "settings": {
        "batch_size": 100
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//workers/queues//consumers/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dead_letter_queue": "updated-example-dlq",
    "environment": "production",
    "script_name": "example-consumer",
    "settings": {
        "batch_size": 100
    }
}'

Responses

🟢200Update Queue Consumer response

application/json

Body

allOf {2}

optional

object (api-response-collection)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

object

optional

result

object | allOf {1}

optional

Example

🟢200Update Queue Consumer response failure

Modified at 2022-12-16 13:48:34

Delete Queue Consumer

List Buckets