Google: Gmail users labels schemas
6 Google schemas with complete fields and constraints.
← Gmail users labels operations · All schemas
Creates a 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 | Required within parent | The visibility of the label in the label list in the Gmail web interface. One of: labelShow, labelShowIfUnread, labelHide |
messageListVisibility | string | Required within parent | 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 | Required within parent | 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
Creates a label For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — response 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. Known values: labelShow, labelShowIfUnread, labelHide |
messageListVisibility | string | Optional | The visibility of messages with this label in the message list in the Gmail web interface. Known values: show, hide |
messagesTotal | JSON | Optional | |
messagesTotal (anyOf 1) | integer | Alternative | The total number of messages with the label. Format: int32 |
messagesTotal (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
messagesUnread | JSON | Optional | |
messagesUnread (anyOf 1) | integer | Alternative | The number of unread messages with the label. Format: int32 |
messagesUnread (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The display name of the label. |
threadsTotal | JSON | Optional | |
threadsTotal (anyOf 1) | integer | Alternative | The total number of threads with the label. Format: int32 |
threadsTotal (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
threadsUnread | JSON | Optional | |
threadsUnread (anyOf 1) | integer | Alternative | The number of unread threads with the label. Format: int32 |
threadsUnread (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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. Known values: 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
Creates a label For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — response body — color
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
backgroundColor | string | Optional | The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 |
textColor | string | Optional | The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: \#000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, \#fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, \#e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, \#cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, \#ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, \#822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c, \#464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, \#711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, \#594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, \#c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, \#662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765, #757575, #1e53b8, \#007286, #7858c3, #c2185b, #d93025, #54240e, #633e04, #521d28, #202124, \#083018 |
Lists all labels in the user's mailbox For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
labels | array | Optional | List of labels. Note that each label resource only contains an `id`, `name`, `messageListVisibility`, `labelListVisibility`, and `type`. The [`labels.get`](https://developers.google.com/workspace/gmail/api/v1/reference/users/labels/get) method can fetch additional label details. |
labels[] | Model | Each item | Expand Creates a label For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — response body |
Referenced models: Creates a label For more information, see Manage labels (https: developers google com workspace gmail api guides labels) — response body
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
Updates 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 | Required within parent | The immutable ID of the label. |
labelListVisibility | string | Required within parent | The visibility of the label in the label list in the Gmail web interface. One of: labelShow, labelShowIfUnread, labelHide |
messageListVisibility | string | Required within parent | 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 | Required within parent | 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