gmail.users.threads.modify
Adds or removes Gmail label IDs across an entire thread, applying the change to every message in a single request.
Instructions
Modifies the labels applied to the thread. This applies to all messages in the thread. 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 body is a JSON ModifyThreadRequest object accepting addLabelIds, removeLabelIds; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, trash, untrash.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | [URL path segment] The ID of the thread to modify. | |
| 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 ModifyThreadRequest object. | |
| request_body | No | Request body of type ModifyThreadRequest: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| snippet | No | ||
| messages | No | ||
| historyId | No |