---
title: "PATCH /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}"
method: PATCH
path: "/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}"
---

# PATCH /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}

`PATCH /persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}`

## Request

- Base URL: `{Endpoint}/face/v1.0`
- URL: `{Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}`
- Auth: API key in header `Ocp-Apim-Subscription-Key`

Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [PersonGroup PersonFace - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/deleteface), [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/faceapi/persongroup/delete) is called.
<br /> Note persistedFaceId is different from faceId generated by [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).
* Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
* Each person entry can hold up to 248 faces.
* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
* "targetFace" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided "targetFace" rectangle is not returned from [Face - Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), there’s no guarantee to detect and add the face successfully.
* Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
* Adding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel.

## Path parameters

- `personGroupId` string, required
- `personId` string, uuid, required
- `persistedFaceId` string, uuid, required

## Request body

- UpdateFaceRequest: Request to update face data.
  - `userData` string: User-provided data attached to the face. The size limit is 1KB.

## Response `200`

A successful call returns an empty response body.

## Other responses

- `default`: Error response.

## Changes

- **2018-08-01** `dcdc115e9ae8`: 1 info
  - endpoint added
- **2017-12-28** `e67414f9aeba`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/azure/apis/cognitiveservices-face/changes/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceId/patch.md)

---

[API](https://skmtc.dev/azure/apis/cognitiveservices-face.md) - [All operations](https://skmtc.dev/azure/apis/cognitiveservices-face/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/cognitiveservices-face/revisions/a35087dfdbc2?raw)