> ## Documentation Index
> Fetch the complete documentation index at: https://docs.r28.ai/charter/llms.txt
> Use this file to discover all available pages before exploring further.

# Objects

> Every object and enum the Label tools accept.

## Model tree

<div className="model-tree"><div className="model-tree-scroll"><div className="tree-node"><a href="#label">Label</a><div className="tree-children"><div className="tree-node"><a href="#color">Color</a></div></div></div><div className="tree-node"><a href="#patchlabelrequest">PatchLabelRequest</a><div className="tree-children"><div className="tree-node"><a href="#color">Color</a></div></div></div></div></div>

## Label

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.

<div className="reference-table">
  | Field                                                        | Type                                            | Description                                                                                            |
  | ------------------------------------------------------------ | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
  | `name` <span className="required" title="required">\*</span> | `string`                                        | The display name of the label.                                                                         |
  | `messageListVisibility`                                      | [MessageListVisibility](#messagelistvisibility) | The visibility of messages with this label in the message list in the Gmail web interface.             |
  | `labelListVisibility`                                        | [LabelListVisibility](#labellistvisibility)     | The visibility of the label in the label list in the Gmail web interface.                              |
  | `color`                                                      | [Color](#color)                                 | The color to assign to the label. Color is only available for labels that have their type set to user. |
</div>

## Color

Color settings for a label.

<div className="reference-table">
  | Field             | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `textColor`       | `string` | 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              |
  | `backgroundColor` | `string` | 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 |
</div>

## PatchLabelRequest

Request body for Gmail `users.labels.patch`.

<div className="reference-table">
  | Field                   | Type                                            | Description                                                                                            |
  | ----------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
  | `name`                  | `string`                                        | The display name of the label.                                                                         |
  | `messageListVisibility` | [MessageListVisibility](#messagelistvisibility) | The visibility of messages with this label in the message list in the Gmail web interface.             |
  | `labelListVisibility`   | [LabelListVisibility](#labellistvisibility)     | The visibility of the label in the label list in the Gmail web interface.                              |
  | `color`                 | [Color](#color)                                 | The color to assign to the label. Color is only available for labels that have their type set to user. |
</div>

## LabelListVisibility

<div className="enum-table">
  | Value               |
  | ------------------- |
  | `labelShow`         |
  | `labelShowIfUnread` |
  | `labelHide`         |
</div>

## MessageListVisibility

<div className="enum-table">
  | Value  |
  | ------ |
  | `show` |
  | `hide` |
</div>
