Create MailFolder
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.
Use this API to create a new mail folder in the root folder of the user's mailbox.
If you intend a new folder to be hidden, you must set the isHidden property to true
on creation.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Mail.ReadWrite |
Delegated (personal Microsoft account) | Mail.ReadWrite |
Application | Mail.ReadWrite |
HTTP request
POST /me/mailFolders
POST /users/{id | userPrincipalName}/mailFolders
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json |
Request body
In the request body, provide a JSON object with the following parameters. displayName and isHidden are the only writable property for a mailFolder object.
Parameter | Type | Description |
---|---|---|
displayName | String | The display name of the new folder. |
isHidden | Boolean | Indicates whether the new folder is hidden. The default value is false . Setting the property is optional. Once set, you cannot update this property. See more information in Hidden mail folders |
Response
If successful, this method returns 201 Created
response code and a mailFolder object in the response body.
Example
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/me/mailFolders
Content-type: application/json
{
"displayName": "Clutter",
"isHidden": true
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-type: application/json
{
"id": "hN2Y5OGRhNGYwODEALgAAA0DAKbvJvFhJgcT3lZpkhNQBAA1",
"displayName": "Clutter",
"parentFolderId": "AQMkADlmOGQwZmU3LWVjOWMtNDhiYgAtODcxNy1",
"childFolderCount": 99,
"unreadItemCount": 99,
"totalItemCount": 99,
"wellKnownName": null,
"isHidden": true
}