Method: users.threads.trash
Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash.
HTTP request
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{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 thread to Trash.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Thread.
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 a specified thread and its associated messages to the trash."],["Requires the user's email address (`userId`) and the thread ID (`id`) as path parameters."],["Uses an empty request body and returns a `Thread` object upon successful completion."],["Needs authorization with either `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.modify` scope."]]],["This document outlines the process for moving a Gmail thread to the trash via an API. The `POST` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}/trash` requires two path parameters: `userId` (user's email, or \"me\") and `id` (thread ID). The request body must be empty. Upon success, the response contains thread details. Authorization requires either `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.modify` OAuth scope.\n"]]
