Create plannerRosterMember

Namespace: microsoft.graph


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


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.
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 Additional roles assigned to the user. Optional. Currently, no additional roles are available for users.
tenantId String Identifier of the tenant the user belongs to. Optional. Currently, roster members cannot be from different tenants.
userId String Identifier of the user.


If successful, this method returns a 201 Created response code and a plannerRosterMember object in the response body.



The following example shows a request.

Content-Type: application/json

  "@odata.type": "#microsoft.graph.plannerRosterMember",
  "userId": "String"


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": [