Create MailFolder

Use this API to create a new mail folder.

Prerequisites

One of the following scopes is required to execute this API: Mail.ReadWrite

HTTP request

POST /users/{id | userPrincipalName}/mailFolders

Request headers

Header Value
Authorization Bearer . Required.
Content-Type application/json

Request body

In the request body, provide a JSON object with the following parameters. displayName is the only writable property for a MailFolder object.

Parameter Type Description
parentFolderId String The folder ID of the parent folder, or the Inbox, Drafts, SentItems, or DeletedItems well-known folder name.
displayName String The display name of the new folder.

Response

If successful, this method returns 201, Created response code and MailFolder object in the response body.

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/me/mailFolders
Content-type: application/json
Content-length: 159

{
  "displayName": "displayName-value",
  "parentFolderId": "parentFolderId-value"
}
Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json
Content-length: 179

{
  "displayName": "displayName-value",
  "parentFolderId": "parentFolderId-value",
  "childFolderCount": 99,
  "unreadItemCount": 99,
  "totalItemCount": 99,
  "id": "id-value"
}