Skip to content

mailfolder-move.md

Latest commit

 

History

History
148 lines (107 loc) · 4.31 KB

mailfolder-move.md

File metadata and controls

148 lines (107 loc) · 4.31 KB
title mailFolder: move
description Move a mail folder and its contents to another mail folder.
author SuryaLashmiS
ms.localizationpriority medium
ms.subservice outlook
doc_type apiPageType
ms.date 04/05/2024

mailFolder: move

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Move a mail folder and its contents to another mail folder.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

POST /me/mailFolders/{id}/move
POST /users/{id | userPrincipalName}/mailFolders/{id}/move

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.

Parameter Type Description
destinationId String The folder ID, or a well-known folder name. For a list of supported well-known folder names, see mailFolder resource type.

Response

If successful, this method returns 200 OK response code and a mailFolder object in the response body.

Example

Here's an example of how to call this API.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/me/mailFolders/{id}/move
Content-type: application/json

{
  "destinationId": "destinationId-value"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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"
}