Update contactfolder
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 contactfolder object.
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) | Contacts.ReadWrite | Not available. |
Delegated (personal Microsoft account) | Contacts.ReadWrite | Not available. |
Application | Contacts.ReadWrite | Not available. |
HTTP request
PATCH /me/contactFolders/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}
Request headers
Header | Value |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
Property | Type | Description |
---|---|---|
displayName | String | The folder's display name. |
parentFolderId | String | The ID of the folder's parent folder. |
wellKnownName | string | The name of the folder if the folder is a recognized folder. Currently contacts is the only recognized contacts folder. |
Response
If successful, this method returns a 200 OK
response code and updated contactFolder object in the response body.
Example
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/me/contactFolders/{id}
Content-type: application/json
{
"parentFolderId": "parentFolderId-value",
"displayName": "displayName-value"
}
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
{
"parentFolderId": "parentFolderId-value",
"displayName": "displayName-value",
"wellKnownName": "wellKnownName-value",
"id": "id-value"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for