Create child folder
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 child mailFolder.
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
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Mail.ReadWrite | Not available. |
Delegated (personal Microsoft account) | Mail.ReadWrite | Not available. |
Application | Mail.ReadWrite | Not available. |
HTTP request
POST /me/mailFolders/{id}/childFolders
POST /users/{id | userPrincipalName}/mailFolders/{id}/childFolders
Specify the parent folder in the query URL as a folder ID, or a well-known folder name. For a list of supported well-known folder names, see mailFolder resource type.
Request headers
Header | Value |
---|---|
Authorization | Bearer {token} . Required. |
Content-Type | application/json . Required. |
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/{id}/childFolders
Content-type: application/json
{
"displayName": "displayName-value",
"isHidden": true
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"displayName": "displayName-value",
"parentFolderId": "parentFolderId-value",
"childFolderCount": 99,
"unreadItemCount": 99,
"totalItemCount": 99,
"id": "id-value",
"isHidden": true
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for