Update profilePhoto
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 photo for the specified contact, group, team, or user in a tenant. The size of the photo you can update to is limited to 4 MB.
You can use either PATCH or PUT for this operation.
This API is available in the following national cloud deployments.
| Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Permissions
To update the profile photo of a contact
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Contacts.ReadWrite | Not supported. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Contacts.ReadWrite | Not supported. |
To update the profile photo of a group
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | ProfilePhoto.ReadWrite.All | Group.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | ProfilePhoto.ReadWrite.All | Group.ReadWrite.All |
To update the profile photo of a team
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | TeamSettings.ReadWrite.All | Not supported. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Not supported. | Not supported. |
To update the profile photo of a user
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | ProfilePhoto.ReadWrite.All | User.ReadWrite, User.ReadWrite.All |
| Delegated (personal Microsoft account) | User.ReadWrite | Not supported. |
| Application | ProfilePhoto.ReadWrite.All | User.ReadWrite.All |
Note
- Permissions marked with * are supported only for backward compatibility. Please update your solutions to use an alternative permission and avoid using these permissions going forward.
- Users with admin roles such as User admins can update the photo of any user in the organization by using delegated permissions. This operation is also supported with application permissions. Updating the photo of any user in the organization requires ProfilePhoto.ReadWrite.All or User.ReadWrite.All permission. Updating the photo of the signed-in user only requires User.ReadWrite permission.
- Updating a user's photo using the Microsoft Graph API is currently not supported in Azure AD B2C tenants.
HTTP request
To update a contact's profile photo:
PATCH /me/contacts/{id}/photo/$value
PATCH /users/{id | userPrincipalName}/contacts/{id}/photo/$value
PATCH /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
PATCH /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
PUT /me/contacts/{id}/photo/$value
PUT /users/{id | userPrincipalName}/contacts/{id}/photo/$value
PUT /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
PUT /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
To update a group photo:
PUT /groups/{id}/photo/$value
To update a team photo:
PUT /teams/{id}/photo/$value
To update a user's profile photo:
PUT /me/photo/$value
PUT /users/{id | userPrincipalName}/photo/$value
Request headers
| Header | Value |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | e.g., image/jpeg. Required. |
Request body
In the request body, include the binary data of the photo.
Response
If successful, this method returns a 200 OK response code or a 204 No Content response code for updating the photo of a team.
Examples
Example 1: Update the profile photo of a user
Request
The following example shows a request.
PUT https://graph.microsoft.com/beta/me/photo/$value
Content-type: image/jpeg
Binary data for the image
Response
The following example shows the response.
HTTP/1.1 200 OK
Example 2: Update the photo of a team
Request
The following example shows a request to update a team photo.
PUT https://graph.microsoft.com/beta/teams/172b0cce-e65d-44ce-9a49-91d9f2e8491e/photo/$value
Content-type: image/jpeg
Binary data for the image
Response
The following example shows the response.
HTTP/1.1 204 No Content