--- title: Create a Queue Consumer --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Queues](https://developers.cloudflare.com/api/go/resources/queues) [Consumers](https://developers.cloudflare.com/api/go/resources/queues/subresources/consumers) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create a Queue Consumer client.Queues.Consumers.New(ctx, queueID, params) (\*[Consumer](), error) POST/accounts/{account\_id}/queues/{queue\_id}/consumers Creates a consumer for a Queue. ##### 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 queueID string A Resource identifier. maxLength32 [Link to this property](<#(resource)%20queues.consumers%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20queue_id%20%3E%20(schema)>)

params ConsumerNewParams

AccountID param.Field\[string] Path param: A Resource identifier. maxLength32 Link to this property ScriptName param.Field\[string] Body param: Name of a Worker Link to this property

Type param.Field\[ConsumerNewParamsMqWorkerConsumerRequestType] Body param

const ConsumerNewParamsMqWorkerConsumerRequestTypeWorker ConsumerNewParamsMqWorkerConsumerRequestType = "worker" Link to this property

Link to this property DeadLetterQueue param.Field\[string]Optional Body param Link to this property

Settings param.Field\[ConsumerNewParamsMqWorkerConsumerRequestSettings]Optional Body param

BatchSize float64Optional The maximum number of messages to include in a batch. Link to this property MaxConcurrency float64Optional 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 MaxRetries float64Optional The maximum number of retries Link to this property MaxWaitTimeMs float64Optional The number of milliseconds to wait for a batch to fill up before attempting to deliver it Link to this property RetryDelay float64Optional The number of seconds to delay before making the message available for another attempt. Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.consumers%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse

type Consumer interface{…} Response body representing a consumer

One of the following:

type ConsumerMqWorkerConsumerResponse struct{…}

ConsumerID stringOptional A Resource identifier. maxLength32 Link to this property CreatedOn TimeOptional formatdate-time Link to this property DeadLetterQueue stringOptional Name of the dead letter queue, or empty string if not configured Link to this property QueueName stringOptional Link to this property ScriptName stringOptional Name of a Worker Link to this property

Settings ConsumerMqWorkerConsumerResponseSettingsOptional

Link to this property Type ConsumerMqWorkerConsumerResponseTypeOptional Link to this property

Link to this property

type ConsumerMqHTTPConsumerResponse struct{…}

Settings ConsumerMqHTTPConsumerResponseSettingsOptional

BatchSize float64Optional The maximum number of messages to include in a batch. Link to this property MaxRetries float64Optional The maximum number of retries Link to this property RetryDelay float64Optional The number of seconds to delay before making the message available for another attempt. Link to this property VisibilityTimeoutMs float64Optional 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 ConsumerMqHTTPConsumerResponseTypeOptional Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.consumers%20%3E%20(model)%20consumer%20%3E%20(schema)>) ### Create a Queue Consumer Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/queues" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) consumer, err := client.Queues.Consumers.New( context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353", queues.ConsumerNewParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Body: queues.ConsumerNewParamsBodyMqWorkerConsumerRequest{ ScriptName: cloudflare.F("my-consumer-worker"), Type: cloudflare.F(queues.ConsumerNewParamsBodyMqWorkerConsumerRequestTypeWorker), }, }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", consumer) } ``` 200 example ``` { "errors": [ { "code": 7003, "message": "No route for the URI", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "result": { "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" }, "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": { "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" }, "success": true } ```