| title | Create plannerRoster |
|---|---|
| description | Create a new plannerRoster object. |
| author | tarkansevilmis |
| ms.localizationpriority | medium |
| ms.subservice | planner |
| doc_type | apiPageType |
| ms.date | 06/05/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Create a new plannerRoster 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/rosters| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | application/json. Required. |
In the request body, supply a JSON representation of the plannerRoster object.
There are no writable properties on plannerRoster.
If successful, this method returns a 201 Created response code and a plannerRoster object in the response body.
This method fails with a 403 Forbidden response code in the following situations. The code property in the error response indicates the specific error.
| Description | Code property value |
|---|---|
| If labels are mandatory for the user and the created roster has no sensitivity label, the request fails. | sensitivityLabelsAreMandatory |
| If the roster is created with guest members initially added, but the proposed sensitivity label disallows the addition of guests, the request fails. | addingGuestUsersProhibitedByLabel |
| If the provided label doesn't have the correct tenant ID, the request fails. | tenantIdIsIncorrect |
For more information, see Microsoft Graph error responses and resource types.
POST https://graph.microsoft.com/beta/planner/rosters
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.plannerRoster"
}[!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]
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.plannerRoster",
"id": "6519868f-868f-6519-8f86-19658f861965"
}