outlookCategory resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Caution
Outlook tasks is deprecated and stopped returning data on August 10, 2022. Update existing apps that use this feature with Outlook tasks.
Represents a category by which a user can group Outlook items such as messages and events. In Outlook, the user defines categories in a master list, and can apply one or more of these user-defined categories to an item.
Using the REST API, you can create and define categories in the master list of categories for a user. You can also get this master list of categories, get a specific category, update the color associated with a category, or delete a category. You can apply a category to an item by assigning the displayName property of the category to the categories collection of the item. Resources that can be assigned categories include contact, event, message, outlookTask, post, and todoTask.
Each category is attributed by two properties: displayName and color. The displayName value must be unique in a user's master list. The color however doesn't have to be unique; multiple categories in the master list can be mapped to the same color. You can map up to 25 different colors to categories in a user's master list.
Methods
| Method | Return Type | Description |
|---|---|---|
| List | outlookCategory collection | Get all the categories that have been defined for the user. |
| Get | outlookCategory | Get the properties and relationships of the specified outlookCategory object. |
| Create | outlookCategory | Create an outlookCategory object in the user's master list of categories. |
| Update | outlookCategory | Update the writable property, color, of the specified outlookCategory object. |
| Delete | None | Delete the specified outlookCategory object. |
Properties
| Property | Type | Description |
|---|---|---|
| color | String | A preset color constant that characterizes a category, and that is mapped to one of 25 predefined colors. For more information, see the following note. |
| displayName | String | A unique name that identifies a category in the user's mailbox. After a category is created, the name can't be changed. Read-only. |
Note The possible values for color are preset constants such as
None,preset0andpreset1. Each preset constant is further mapped to a color; the actual color is dependent on the Outlook client that the categories are being displayed in. The following table shows the colors mapped to each preset constant for Outlook (desktop client).
| Preset constant | Color mapped to in Outlook |
|---|---|
| None | No color mapped |
| Preset0 | Red |
| Preset1 | Orange |
| Preset2 | Brown |
| Preset3 | Yellow |
| Preset4 | Green |
| Preset5 | Teal |
| Preset6 | Olive |
| Preset7 | Blue |
| Preset8 | Purple |
| Preset9 | Cranberry |
| Preset10 | Steel |
| Preset11 | DarkSteel |
| Preset12 | Gray |
| Preset13 | DarkGray |
| Preset14 | Black |
| Preset15 | DarkRed |
| Preset16 | DarkOrange |
| Preset17 | DarkBrown |
| Preset18 | DarkYellow |
| Preset19 | DarkGreen |
| Preset20 | DarkTeal |
| Preset21 | DarkOlive |
| Preset22 | DarkBlue |
| Preset23 | DarkPurple |
| Preset24 | DarkCranberry |
JSON representation
The following JSON representation shows the resource type.
{
"color": "String",
"displayName": "String"
}