Method: users.messages.trash
Moves the specified message to the trash.
HTTP request
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/trash
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userId |
string
The user's email address. The special value me can be used to indicate the authenticated user.
|
id |
string
The ID of the message to Trash.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Message.
Authorization scopes
Requires one of the following OAuth scopes:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Moves the specified message to the trash using the Gmail API."],["Requires the user's email address and the message ID as path parameters."],["An empty request body is necessary, and a successful response returns the message details."],["Needs authorization with specific OAuth scopes for modifying Gmail access."]]],["This document outlines the process for moving a message to the trash using the Gmail API. It requires a `POST` request to a specific URL: `https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/trash`. The `userId` and `id` of the message are specified in the path. The request body must be empty. Upon success, the API returns a `Message` instance. Authorization requires either `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.modify` OAuth scopes.\n"]]
