gmail.users.messages.batchDelete
Deletes multiple Gmail messages by ID in one batch request for bulk cleanup, removing specified messages without individual delete calls.
Instructions
Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchDeleteMessagesRequest object accepting ids; pass it via params or whole via body_file Siblings over the same resource: batchModify, delete, get, import, insert, list, modify, send, trash, untrash.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| userId | Yes | [URL path segment] The user's email address. The special value `me` can be used to indicate the authenticated user. | me |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON BatchDeleteMessagesRequest object. | |
| request_body | No | Request body of type BatchDeleteMessagesRequest: pass it via `params` (merged into the built body) or whole via `body_file`. |