queue.messages.delete-batch

Delete up to 10 processed messages by receipt handle

POST /queue/api/queues/{name}/messages/delete-batchIAM queue:DeleteMessageChanges stateDestructive

Answers { successful, failed } per entry id; a failed entry does not fail the call.

Request syntax

POST /queue/api/queues/{name}/messages/delete-batch
{
  "entries": "array of json"
}

Path parameters

  • nameRequired

    string

    Constraints: max 80 chars, /^[A-Za-z0-9_-]+(\.fifo)?$/

Request body

  • entriesRequired

    array of json

    The messages to delete, each a receiptHandle from the receive plus an id of your choosing, unique in the batch, that matches it to its result

Response

200; data holds successful (the entry ids that succeeded) and failed (id, code and error for each entry that did not).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow queue:DeleteMessage on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud queue messages delete-batch name --entries '["example"]'

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_queue_messages_delete-batch.