--- title: Update Queue --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Queues](https://developers.cloudflare.com/api/python/resources/queues) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update Queue queues.edit(strqueue\_id, QueueEditParams\*\*kwargs) -> [Queue]() PATCH/accounts/{account\_id}/queues/{queue\_id} Updates part of a Queue’s configuration. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Queues Write``Workers Scripts Write` ##### ParametersExpand Collapse account\_id: str A Resource identifier. maxLength32 [Link to this property](<#(resource)%20queues%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) queue\_id: str A Resource identifier. maxLength32 [Link to this property](<#(resource)%20queues%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20queue_id%20%3E%20(schema)>)
jurisdiction: Optional\[Literal\["eu", "us", "fedramp"]] One of the following: "eu" Link to this property "us" Link to this property "fedramp" Link to this property
[Link to this property](<#(resource)%20queues%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20jurisdiction%20%3E%20(schema)>) queue\_name: Optional\[str] [Link to this property](<#(resource)%20queues%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20queue_name%20%3E%20(schema)>)
settings: Optional\[Settings] delivery\_delay: Optional\[float] Number of seconds to delay delivery of all messages to consumers. Link to this property delivery\_paused: Optional\[bool] Indicates if message delivery to consumers is currently paused. Link to this property message\_retention\_period: Optional\[float] Number of seconds after which an unconsumed message will be delayed. Link to this property
[Link to this property](<#(resource)%20queues%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20settings%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class Queue: …
consumers: Optional\[List\[Consumer]] One of the following:
class MqWorkerConsumerResponse: … consumer\_id: Optional\[str] A Resource identifier. maxLength32 Link to this property created\_on: Optional\[datetime] formatdate-time Link to this property dead\_letter\_queue: Optional\[str] Name of the dead letter queue, or empty string if not configured Link to this property queue\_name: Optional\[str] Link to this property script\_name: Optional\[str] Name of a Worker Link to this property
settings: Optional\[MqWorkerConsumerResponseSettings] batch\_size: Optional\[float] The maximum number of messages to include in a batch. Link to this property max\_concurrency: Optional\[float] Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform’s maximum (recommended). Link to this property max\_retries: Optional\[float] The maximum number of retries Link to this property max\_wait\_time\_ms: Optional\[float] The number of milliseconds to wait for a batch to fill up before attempting to deliver it Link to this property retry\_delay: Optional\[float] The number of seconds to delay before making the message available for another attempt. Link to this property
Link to this property type: Optional\[Literal\["worker"]] Link to this property
Link to this property
class MqHTTPConsumerResponse: … consumer\_id: Optional\[str] A Resource identifier. maxLength32 Link to this property created\_on: Optional\[datetime] formatdate-time Link to this property dead\_letter\_queue: Optional\[str] Name of the dead letter queue, or empty string if not configured Link to this property queue\_name: Optional\[str] Link to this property
settings: Optional\[MqHTTPConsumerResponseSettings] batch\_size: Optional\[float] The maximum number of messages to include in a batch. Link to this property max\_retries: Optional\[float] The maximum number of retries Link to this property retry\_delay: Optional\[float] The number of seconds to delay before making the message available for another attempt. Link to this property visibility\_timeout\_ms: Optional\[float] The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt. Link to this property
Link to this property type: Optional\[Literal\["http\_pull"]] Link to this property
Link to this property
Link to this property consumers\_total\_count: Optional\[float] Link to this property created\_on: Optional\[str] Link to this property
jurisdiction: Optional\[Literal\["eu", "us", "fedramp"]] One of the following: "eu" Link to this property "us" Link to this property "fedramp" Link to this property
Link to this property modified\_on: Optional\[str] Link to this property
producers: Optional\[List\[Producer]] One of the following:
class ProducerMqWorkerProducer: … script: Optional\[str] Link to this property type: Optional\[Literal\["worker"]] Link to this property
Link to this property
class ProducerMqR2Producer: … bucket\_name: Optional\[str] Link to this property type: Optional\[Literal\["r2\_bucket"]] Link to this property
Link to this property
Link to this property producers\_total\_count: Optional\[float] Link to this property queue\_id: Optional\[str] Link to this property queue\_name: Optional\[str] Link to this property
settings: Optional\[Settings] delivery\_delay: Optional\[float] Number of seconds to delay delivery of all messages to consumers. Link to this property delivery\_paused: Optional\[bool] Indicates if message delivery to consumers is currently paused. Link to this property message\_retention\_period: Optional\[float] Number of seconds after which an unconsumed message will be delayed. Link to this property
Link to this property
[Link to this property](<#(resource)%20queues%20%3E%20(model)%20queue%20%3E%20(schema)>) ### Update Queue Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) queue = client.queues.edit( queue_id="023e105f4ecef8ad9ca31a8372d0c353", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(queue.queue_id) ``` 200 example ``` { "errors": [ { "code": 7003, "message": "No route for the URI", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "result": { "consumers": [ { "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2019-12-27T18:11:19.117Z", "dead_letter_queue": "dead_letter_queue", "queue_name": "example-queue", "script_name": "my-consumer-worker", "settings": { "batch_size": 50, "max_concurrency": 10, "max_retries": 3, "max_wait_time_ms": 5000, "retry_delay": 10 }, "type": "worker" } ], "consumers_total_count": 0, "created_on": "created_on", "jurisdiction": "eu", "modified_on": "modified_on", "producers": [ { "script": "script", "type": "worker" } ], "producers_total_count": 0, "queue_id": "queue_id", "queue_name": "example-queue", "settings": { "delivery_delay": 5, "delivery_paused": true, "message_retention_period": 345600 } }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 7003, "message": "No route for the URI", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "result": { "consumers": [ { "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2019-12-27T18:11:19.117Z", "dead_letter_queue": "dead_letter_queue", "queue_name": "example-queue", "script_name": "my-consumer-worker", "settings": { "batch_size": 50, "max_concurrency": 10, "max_retries": 3, "max_wait_time_ms": 5000, "retry_delay": 10 }, "type": "worker" } ], "consumers_total_count": 0, "created_on": "created_on", "jurisdiction": "eu", "modified_on": "modified_on", "producers": [ { "script": "script", "type": "worker" } ], "producers_total_count": 0, "queue_id": "queue_id", "queue_name": "example-queue", "settings": { "delivery_delay": 5, "delivery_paused": true, "message_retention_period": 345600 } }, "success": true } ```