Share via

Person Group Operations - Update Person Group Person

  • Reference
Service:
Azure AI Services
API Version:
v1.2-preview.1

Update name or userData of a person.

PATCH {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons/{personId}

URI Parameters

Name In Required Type Description
apiVersion
 path True

string

API Version
endpoint
 path True

string

uri

Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).
personGroupId
 path True

string

ID of the container.

Regex pattern: ^[a-z0-9-_]+$
personId
 path True

string

uuid

ID of the person.

Request Body

Name Type Description
name

string

User defined name, maximum length is 128.
userData

string

Optional user defined data. Length should not exceed 16K.

Responses

Name Type Description
200 OK

The request has succeeded.
Other Status Codes

FaceErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

The secret key for your Azure AI Face subscription.

Type: apiKey
In: header

AADToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Update PersonGroup Person

Sample request

PATCH {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

{
  "name": "your_person_group_person_name",
  "userData": "your_user_data"
}

Sample response

Status code:
200

Definitions

Name Description
FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

A response containing error details.
UserDefinedFieldsForUpdate

User defined fields for object update.

FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.

Name Type Description
code

string

One of a server-defined set of error codes.
message

string

A human-readable representation of the error.

FaceErrorResponse

A response containing error details.

Name Type Description
error

FaceError

The error object.

UserDefinedFieldsForUpdate

User defined fields for object update.

Name Type Description
name

string

User defined name, maximum length is 128.
userData

string

Optional user defined data. Length should not exceed 16K.