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.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Tasks.ReadWrite
Delegated (personal Microsoft account) Not supported.
Application Tasks.ReadWrite.All

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 shows the properties that are required when you create the plannerRosterMember.

Property Type Description
userId String Identifier of the user.
tenantId String Identifier of the tenant the user belongs to. Optional. Currently roster members cannot be from different tenants.
roles String collection Additional roles assigned to the user. Optional. Currently there are no additional roles available for users.


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



Content-Type: application/json

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


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