Update community

Namespace: microsoft.graph

Update the properties of an existing Viva Engage community.

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) Community.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Community.ReadWrite.All Not available.

HTTP request

PATCH /employeeExperience/communities/{communityId}

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 only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
description String The description of the community. Maximum length is 1,024 characters.
displayName String The name of the community. Maximum length is 255 characters.
privacy communityPrivacy Defines the privacy level of the community. The possible values are: public, private, unknownFutureValue.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/employeeExperience/communities/eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0
Content-Type: application/json

{
  "displayName": "Financial Advice for Software Engineers",
  "description": "A community where financial advisors who represent customers from software engineering profession can discuss advice and suggestions for their clients.",
  "privacy": "public"
}

Response

The following example shows the response.

HTTP/1.1 204 No Content