Cloudinary API
Cloudinary DocsGet API keys
HomeAPI ReferenceSDKsContext Plugin
People

Update a person

PUT
/v1_1/{cloud_name}/people/{person_id}

Updates a recognized person's name, status, or thumbnail image. At least one of name, status, or thumbnail_asset_id must be provided. People Search must be enabled for this product environment.

Authorization

AuthorizationBasic <token>

Basic authentication using Cloudinary API Key and API Secret.

In: header

Path Parameters

cloud_name*string

The cloud name of your product environment.

person_id*string

The unique identifier of the person.

Request Body

application/json

The updated person attributes.

name?string

The display name for the person. Maximum 255 characters.

Lengthlength <= 255
status?person_status

The status of a person.

Value in

  • "active"
  • "hidden"
thumbnail_asset_id?string

The external ID of an asset containing this person's face to use as the thumbnail.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1_1/my_cloud/people/f10f893da5a1586dca6764b22514aa0d25e6b867baffc4fb43a2318a25d8e5b2" \  -H "Content-Type: application/json" \  -d '{}'
{  "person_id": "string",  "name": "string",  "status": "active"}

Get person details GET

Returns details of a specific recognized person. People Search must be enabled for this product environment.

Inspect the caller's permitted actions on people POST

Returns, for each requested person and action, whether the authenticated caller is permitted to perform that action.