Update pronounsSettings

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.

Update the properties of a pronounsSettings object in an organization.

For more information on settings to manage pronouns support, see Manage pronouns settings for an organization using the Microsoft Graph API.

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

Note: Using delegated permissions for this operation requires the signed-in user to have a Global Administrator role.

HTTP request

PATCH /admin/people/pronouns

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
isEnabledInOrganization Boolean true to enable pronouns in the organization; otherwise, false. The default value is false, and pronouns are disabled. Required.

Response

If successful, this method returns a 200 OK response code and an updated pronounsSettings object in the response body.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/admin/people/pronouns
Content-Type: application/json

{
  "isEnabledInOrganization": true
}

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "isEnabledInOrganization": true
}