gmail.users.labels.patch
Update specific fields of a Gmail label, such as name, color, or visibility, without replacing the entire label. Use this to change label properties while preserving other settings.
Instructions
Patch the specified label. For more information, see Manage labels [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Label object accepting color, id, labelListVisibility, messageListVisibility, messagesTotal, messagesUnread, name, threadsTotal and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, update.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | [URL path segment] The ID of the label to update. | |
| 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 Label object. | |
| request_body | No | Request body of type Label: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| name | No | ||
| type | No | ||
| color | No | ||
| threadsTotal | No | ||
| messagesTotal | No | ||
| threadsUnread | No | ||
| messagesUnread | No | ||
| labelListVisibility | No | ||
| messageListVisibility | No |