PATCH /persongroups/{personGroupId}

Changed on

Update an existing Person Group's name and userData. The properties keep unchanged if they are not in request body.

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.

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 PersonGroup_Update removed and replaced with PersonGroupOperations_UpdatePersonGroup