--- title: Messages --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Queues](https://developers.cloudflare.com/api/resources/queues) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Messages ##### [Push Message](https://developers.cloudflare.com/api/resources/queues/subresources/messages/methods/push) POST/accounts/{account\_id}/queues/{queue\_id}/messages ##### [Acknowledge + Retry Queue Messages](https://developers.cloudflare.com/api/resources/queues/subresources/messages/methods/ack) POST/accounts/{account\_id}/queues/{queue\_id}/messages/ack ##### [Pull Queue Messages](https://developers.cloudflare.com/api/resources/queues/subresources/messages/methods/pull) POST/accounts/{account\_id}/queues/{queue\_id}/messages/pull ##### [Push Message Batch](https://developers.cloudflare.com/api/resources/queues/subresources/messages/methods/bulk_push) POST/accounts/{account\_id}/queues/{queue\_id}/messages/batch ##### [Peek Queue Messages](https://developers.cloudflare.com/api/resources/queues/subresources/messages/methods/peek) POST/accounts/{account\_id}/queues/{queue\_id}/messages/peek ##### [Purge Peeked Queue Messages](https://developers.cloudflare.com/api/resources/queues/subresources/messages/methods/purge) POST/accounts/{account\_id}/queues/{queue\_id}/messages/purge ##### ModelsExpand Collapse

MessagePushResponse object {metadata }

metadata: optional object {metrics }

metrics: optional object {backlog\_bytes, backlog\_count, oldest\_message\_timestamp\_ms } Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

backlog\_bytes: number The size in bytes of unacknowledged messages in the queue. Link to this property backlog\_count: number The number of unacknowledged messages in the queue. Link to this property oldest\_message\_timestamp\_ms: number Unix timestamp in milliseconds of the oldest unacknowledged message in the queue. Returns 0 if unknown. Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_push_response%20%3E%20(schema)>)

MessageAckResponse object {ackCount, retryCount, warnings }

ackCount: optional number The number of messages that were succesfully acknowledged. Link to this property retryCount: optional number The number of messages that were succesfully retried. Link to this property warnings: optional map\[string] Map of lease IDs to warning messages encountered during acknowledgement. Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_ack_response%20%3E%20(schema)>)

MessagePullResponse object {message\_backlog\_count, messages, metadata }

message\_backlog\_count: optional number The number of unacknowledged messages in the queue. Link to this property

messages: optional array of object {id, attempts, body, 3 more }

id: optional string Link to this property attempts: optional number Link to this property body: optional string Link to this property lease\_id: optional string An ID that represents an “in-flight” message that has been pulled from a Queue. You must hold on to this ID and use it to acknowledge this message. Link to this property metadata: optional unknown Link to this property timestamp\_ms: optional number Link to this property

Link to this property

metadata: optional object {metrics }

metrics: optional object {backlog\_bytes, backlog\_count, oldest\_message\_timestamp\_ms } Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_pull_response%20%3E%20(schema)>)

MessageBulkPushResponse object {metadata }

metadata: optional object {metrics }

metrics: optional object {backlog\_bytes, backlog\_count, oldest\_message\_timestamp\_ms } Best-effort metrics for the queue. Values may be approximate due to the distributed nature of queues.

Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_bulk_push_response%20%3E%20(schema)>)

MessagePeekResponse object {messages }

messages: optional array of object {id, attempts, body, 3 more }

id: optional string Link to this property attempts: optional number Link to this property body: optional string Link to this property metadata: optional unknown Link to this property ref: optional string An opaque reference to a peeked message. You must hold on to this value and use it to purge the message. Link to this property timestamp\_ms: optional number Link to this property

Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_peek_response%20%3E%20(schema)>)

MessagePurgeResponse object {errors, warnings }

errors: optional array of object {message } Errors encountered while purging messages.

message: optional string Link to this property

Link to this property warnings: optional map\[string] Map of refs to warning messages encountered during purge. Link to this property

[Link to this property](<#(resource)%20queues.messages%20%3E%20(model)%20message_purge_response%20%3E%20(schema)>)