Edit

Share via


plannerPlan: moveToContainer

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.

Move a planner plan object from one planner plan container to another. Planner plans can only be moved from a user container to a group container.

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) Tasks.Read Tasks.ReadWrite
Delegated (personal Microsoft account) Not supported. Not supported.
Application Tasks.Read.All Tasks.ReadWrite.All

HTTP request

POST /planner/plans/{planId}/moveToContainer

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.
If-Match Last known ETag value for the plannerPlan to be moved. Required.

Request body

In the request body, supply a JSON representation of the plannerPlanContainer object.

Response

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

Example

Request

The following example shows a request to move a plan from a user container to a group container.

POST https://graph.microsoft.com/beta/planner/plans/{planId}/moveToContainer
Content-type: application/json
If-Match: "string"

{
    "container": {
        "containerId": "groupId",
        "type": "group"
    }
}

Response

The following example shows a response to a request to move a plan from a user container to a group container.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#plans/$entity",
    "@odata.etag": "W/\"JzEtUGxhbiAgQEBAQEBAQEBAQEBAQEBARCc=\"",
    "title": "The Plan",
    "id": "planId",
    "container": {
        "containerId": "groupId",
        "type": "group",
        "url": "https://graph.microsoft.com/beta/groups/groupId"

    }
}