Skip to content

plannerroster-post-members.md

Latest commit

 

History

History
136 lines (101 loc) · 4.89 KB

plannerroster-post-members.md

File metadata and controls

136 lines (101 loc) · 4.89 KB
title Create plannerRosterMember
description Create a new plannerRosterMember object.
author tarkansevilmis
ms.localizationpriority medium
ms.subservice planner
doc_type apiPageType
ms.date 06/05/2024

Create plannerRosterMember

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Add a member to the plannerRoster object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

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.

HTTP

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"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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