Skip to content

userconfiguration-update.md

Latest commit

 

History

History
125 lines (100 loc) · 3.5 KB

userconfiguration-update.md

File metadata and controls

125 lines (100 loc) · 3.5 KB
title Update userConfiguration
description Update the properties of a userConfiguration object.
author daiyue-microsoft
ms.date 11/05/2025
ms.localizationpriority medium
ms.subservice outlook
doc_type apiPageType

Update userConfiguration

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of a userConfiguration object.

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

PATCH /me/mailFolders/{mailFolderId}/userConfigurations/{userConfigurationId}
PATCH /users/{usersId}/mailFolders/{mailFolderId}/userConfigurations/{userConfigurationId}

Request headers

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

Request body

[!INCLUDE table-intro]

Property Type Description
binaryData Binary Arbitrary binary data. Optional.
structuredData structuredDataEntry collection Key-value pairs of supported data types. Optional.
xmlData Binary Binary data for storing serialized XML. Optional.

Response

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

Examples

Request

The following example shows a request.

Note: The entire structuredData object is updated.

HTTP

PATCH https://graph.microsoft.com/beta/me/mailFolders/inbox/userConfigurations/MyApp
Content-Type: application/json

{
  "structuredData": [
    {
      "keyEntry":
      {
        "type": "string",
        "values": [
          "name"
        ]
      },
      "valueEntry":
      {
        "type": "string",
        "values": [
          "Snow"
        ]
      }
    }
  ]
}

JavaScript

[!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 200 OK
Content-Type: application/json

{
   "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('f42c50f8-1300-48a0-93d4-6481acda7efb')/mailFolders('inbox')/userConfigurations/$entity",
  "structuredData": [
    {
      "@odata.type": "microsoft.graph.structuredDataEntry"
    }
  ]
}