Update profileCardProperty

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 profileCardProperty object, identified by its directoryPropertyName property.

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 Not supported. Not supported.

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

HTTP request

PATCH /admin/people/profileCardProperties/{id}

Note: The /organization/{organizationId}/settings path is deprecated. Going forward, use the /admin/people path.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Note: To avoid encoding issues that malform the payload, use Content-Type: application/json; charset=utf-8.

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
annotations profileCardAnnotation collection Any alternative or localized labels an administrator chose to specify.
directoryPropertyName String The name of the directory property that is intended to surface on the profile card.

Response

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

Examples

Request

The following example adds a localized label Kostnadssenter for the locale no.

PATCH https://graph.microsoft.com/beta/admin/people/profileCardProperties/CustomAttribute1
Content-type: application/json; charset=utf-8

{
  "annotations": [
    {
      "displayName": "Cost Center",
      "localizations": [
        {
          "languageTag": "no",
          "displayName": "Kostnadssenter"
        }
      ]
    }
  ]
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8

{
  "directoryPropertyName": "CustomAttribute1",
  "annotations": [
    {
      "displayName": "Cost Center",
      "localizations": [
        {
          "languageTag": "no",
          "displayName": "Kostnadssenter"
        }
      ]
    }
  ]
}