gmail.users.threads.trash
Move a Gmail thread and all its messages to the trash. Use it to remove an email conversation without permanently deleting it.
Instructions
Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. For more information, see Manage threads [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: delete, get, list, modify, untrash.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | [URL path segment] The ID of the thread to Trash. | |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| snippet | No | ||
| messages | No | ||
| historyId | No |