Skip to main content
DELETE
Bulk Cancel Messages

Authorizations

Authorization
string
header
required

QStash authentication token

Query Parameters

messageIds
string[]

A list of message IDs to delete. If provided, other filters are ignored.

topicName
string[]

Filter messages by URL Group name. Supports multiple values.

queueName
string[]

Filter messages by Queue name. Supports multiple values.

url
string[]

Filter messages by destination URL. Supports multiple values.

host
string[]

Filter messages by the host of the destination URL. Supports multiple values.

path
string[]

Filter messages by the path of the destination URL. Supports multiple values.

label
string[]

Filter messages by label. Supports multiple values. You can pass multiple values to match messages with any of the given labels (OR logic).

Examples:

  • label=my_label
  • label=label_1&label=label_2
  • label=label_1,label_2
flowControlKey
string[]

Filter messages by Flow Control Key. Supports multiple values.

fromDate
integer

Filter messages created after this timestamp (Unix milli, inclusive).

toDate
integer

Filter messages created before this timestamp (Unix milli, inclusive).

scheduleId
string[]

Filter messages by Schedule ID. Supports multiple values.

callerIp
string[]

Filter messages by the IP address of the publisher. Supports multiple values.

callerIP
string[]

Deprecated. Use callerIp instead.

count
integer

Maximum number of messages to delete, between 1 and 500. If not provided, all messages matching the filters will be deleted.

Required range: 1 <= x <= 500

Response

200 - application/json

All messages deleted successfully

cancelled
integer

Number of messages cancelled