Skip to content
Start here

Messages

Push Message
POST/accounts/{account_id}/queues/{queue_id}/messages
Acknowledge + Retry Queue Messages
POST/accounts/{account_id}/queues/{queue_id}/messages/ack
Pull Queue Messages
POST/accounts/{account_id}/queues/{queue_id}/messages/pull
Push Message Batch
POST/accounts/{account_id}/queues/{queue_id}/messages/batch
ModelsExpand Collapse
MessagePushResponse { errors, messages, success }
errors: optional array of ResponseInfo { code, message, documentation_url, source }
minLength1
code: number
minimum1000
message: string
documentation_url: optional string
source: optional { pointer }
pointer: optional string
messages: optional array of string
success: optional true

Indicates if the API call was successful or not.

MessageAckResponse { ackCount, retryCount, warnings }
ackCount: optional number

The number of messages that were succesfully acknowledged.

retryCount: optional number

The number of messages that were succesfully retried.

warnings: optional array of string
MessagePullResponse { message_backlog_count, messages }
message_backlog_count: optional number

The number of unacknowledged messages in the queue

messages: optional array of { id, attempts, body, 3 more }
id: optional string
attempts: optional number
body: optional string
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.

metadata: optional unknown
timestamp_ms: optional number
MessageBulkPushResponse { errors, messages, success }
errors: optional array of ResponseInfo { code, message, documentation_url, source }
minLength1
code: number
minimum1000
message: string
documentation_url: optional string
source: optional { pointer }
pointer: optional string
messages: optional array of string
success: optional true

Indicates if the API call was successful or not.