PATCH /persongroups/{personGroupId}/persons/{personId}

Changed on

Update name or userData of a person.

Request

  • Base URL
    {endpoint}/face/{apiVersion}
  • Auth
    • API key in header Ocp-Apim-Subscription-Key
    • or OAuth 2
      Authorization codehttps://api.example.com/oauth2/authorize
      Token URLhttps://api.example.com/oauth2/token
      Scopeshttps://cognitiveservices.azure.com/.default

Path parameters

personGroupIdstring required

ID of the container.

personIdstring uuid required

ID of the person.

Request body

namestring

User defined name, maximum length is 128.

userDatastring

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

Response

The request has succeeded.

Changes

    • info

      api operation id PersonGroupPerson_Update removed and replaced with PersonGroupOperations_UpdatePersonGroupPerson