outlookCategory resource type

Important: APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

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, and post.

Each category is attributed by 2 properties: displayName and color. The displayName value must be unique in a user's master list. The color however does not 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.

Properties

Property Type Description
displayName String A unique name that identifies a category in the user's mailbox. After a category is created, the name cannot be changed. Read-only.
color String A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors. See the note below.

Note The possible values for color are pre-set constants such as None, preset0 and preset1. Each pre-set 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 pre-set constant for Outlook (desktop client).

Pre-set 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

Here is a JSON representation of the resource.

{
  "color": "String",
  "displayName": "String"
}

Methods

Method Return Type Description
List categories outlookCategory collection Get all the categories that have been defined for the user.
Get category 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.