Create plannerRosterMember
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.
Add a member to the plannerRoster object.
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.ReadWrite | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Tasks.ReadWrite.All | Not available. |
HTTP request
POST /planner/rosters/{plannerRosterId}/members
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the plannerRosterMember object.
The following table lists the properties that are required when you create the plannerRosterMember.
Property | Type | Description |
---|---|---|
roles | String collection | Other roles assigned to the user. Optional. Currently, no other roles are available for users. |
tenantId | String | Identifier of the tenant the user belongs to. Optional. Currently, roster members can't be from different tenants. |
userId | String | Identifier of the user. |
Response
If successful, this method returns a 201 Created
response code and a plannerRosterMember object in the response body.
This method returns a 403 Forbidden
response code if the sensitivity label on the roster disallows the addition of guests and the request adds guests to the plannerRoster. The request fails, and the code property in the error resource type has the value addingGuestUsersProhibitedByLabel
.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/planner/rosters/6519868f-868f-6519-8f86-19658f861965/members
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.plannerRosterMember",
"userId": "String"
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.plannerRosterMember",
"id": "670095cd-95cd-6700-cd95-0067cd950067",
"userId": "5ba84f7a-aa11-4a51-a298-9f2c7ec6bb38",
"roles": [
]
}
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