Updates the consumer for a queue, or creates one if it does not exist.
/accounts/{account_identifier}/workers/queues/{name}/consumers/{consumer_name}
put
Queue
queue-update-queue-consumer
null{
"enum": [
"com.cloudflare.edge.worker.queue.update"
]
}[
{
"in": "path",
"name": "consumer_name",
"required": true,
"schema": {
"example": "example-consumer",
"type": "string"
}
},
{
"in": "path",
"name": "name",
"required": true,
"schema": {
"example": "example-queue",
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"example": {
"dead_letter_queue": "updated-example-dlq",
"environment": "production",
"script_name": "example-consumer",
"settings": {
"batch_size": 100
}
}
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"allOf": [
{
"properties": {
"created_on": {
"readOnly": true
},
"dead_letter_queue": {
"example": "updated-example-dlq"
},
"environment": {
"readOnly": true
},
"queue_name": {
"readOnly": true
},
"script_name": {
"readOnly": true
},
"settings": {
"properties": {
"batch_size": {
"example": 100,
"type": "number"
},
"max_retries": {
"example": 3,
"type": "number"
},
"max_wait_time_ms": {
"example": 5000,
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
}
},
"required": [
"queue_name",
"script_name",
"settings",
"dead_letter_queue",
"created_on"
],
"type": "object"
}
]
}
}
},
"description": "Update Queue Consumer response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"allOf": [
{
"properties": {
"created_on": {
"readOnly": true
},
"dead_letter_queue": {
"example": "updated-example-dlq"
},
"environment": {
"readOnly": true
},
"queue_name": {
"readOnly": true
},
"script_name": {
"readOnly": true
},
"settings": {
"properties": {
"batch_size": {
"example": 100,
"type": "number"
},
"max_retries": {
"example": 3,
"type": "number"
},
"max_wait_time_ms": {
"example": 5000,
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
],
"type": "object"
}
},
"required": [
"queue_name",
"script_name",
"settings",
"dead_letter_queue",
"created_on"
],
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Update Queue Consumer response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]