Google: Patch the specified label For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — request body — body
Patch the specified label. For more information, see [Manage labels](https://developers.google.com/workspace/gmail/api/guides/labels).: request body, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Patch the specified label For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Labels are used to categorize messages and threads within the user’s mailbox. The maximum number of labels supported for a user’s mailbox is 10,000. |
color | Model | Optional | Expand Creates a label For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — response body — color The color to assign to the label. Color is only available for labels that have their `type` set to `user`. |
id | string | Optional | The immutable ID of the label. |
labelListVisibility | string | Optional | The visibility of the label in the label list in the Gmail web interface. One of: labelShow, labelShowIfUnread, labelHide |
messageListVisibility | string | Optional | The visibility of messages with this label in the message list in the Gmail web interface. One of: show, hide |
messagesTotal | integer | Optional | The total number of messages with the label. Format: int32 |
messagesUnread | integer | Optional | The number of unread messages with the label. Format: int32 |
name | string | Optional | The display name of the label. |
threadsTotal | integer | Optional | The total number of threads with the label. Format: int32 |
threadsUnread | integer | Optional | The number of unread threads with the label. Format: int32 |
type | string | Optional | The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the `INBOX` and `UNREAD` labels from messages and threads, but cannot apply or remove the `DRAFTS` or `SENT` labels from messages or threads. One of: system, user |
Referenced models: Creates a label For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — response body — color