Messages

Batch Messages

Send multiple messages in a single request

post/v2/batch

Request

Request body

destinationstring required

Destination can either be a valid URL where the message gets sent to, or a URL Group name.

  • If the destination is a URL, make sure the URL is prefixed with a valid protocol (http:// or https://)
  • If the destination is a URL Group, a new message will be created for each endpoint in the group.

Note that destination must be publicly accessible over the internet. If you are working with local endpoints, consider using QStash local development server or a public tunnel service.

bodystring

The raw request message passed to the endpoints as is

headersobject

HTTP headers of the message. You can pass all the headers supported in the single publish API.

queuestring

Queue name to enqueue the message to if desired.

Response

Messages published successfully

messageIdstring

Unique identifier for the published message or the old message ID if deduplicated

deduplicatedboolean

Whether this message is a duplicate and was not sent to the destination.

Changes

No recorded changes to this operation across all 17 revisions of this API.