| title | Create plannerPlan |
|---|---|
| description | Create a new plannerPlan object. |
| ms.localizationpriority | medium |
| author | TarkanSevilmis |
| ms.subservice | planner |
| doc_type | apiPageType |
| ms.date | 04/16/2024 |
Namespace: microsoft.graph
Create a new plannerPlan object.
[!INCLUDE national-cloud-support]
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]
POST /planner/plans| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
In the request body, supply a JSON representation of plannerPlan object.
The following table shows the properties that are required when you create a plannerPlan.
| Property | Type | Description |
|---|---|---|
| container | plannerPlanContainer | Identifies the container of the plan. Specify only the url, the containerId and type, or all properties. After it's set, this property can't be updated. |
| title | String | The title of the plan. |
Note: If the container is a Microsoft 365 group, the user who creates the plan must be a member of the group that contains the plan. When you create a new group by using Create group, you aren't added to the group as a member. After the group is created, add yourself as a member by using group post members.
If successful, this method returns a 201 Created response code and a plannerPlan object in the response body.
This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 400, 403, and 404 responses. For more information about these errors, see Common Planner error conditions.
The following example shows a request.
POST https://graph.microsoft.com/v1.0/planner/plans
Content-type: application/json
{
"container": {
"url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
},
"title": "title-value"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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
{
"createdBy": {
"application": {
"id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
},
"user": {
"id": "b108ebf3-4e22-b93d-5234-dae5874656d7"
}
},
"createdDateTime": "2015-03-30T18:36:49.2407981Z",
"container": {
"@odata.type": "microsoft.graph.plannerPlanContainer",
"url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874",
"containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
"type": "group"
},
"title": "title-value",
"id": "xqQg5FS2LkCp935s-FIFm2QAFkHM"
}