Skip to main content
PATCH
Update a person

Path Parameters

person_id
string
required

Person ID (with person_ prefix) of the person to update.

Body

application/json
name
string | null

New display name. Omit to leave unchanged.

Maximum string length: 255
birth_date
string<date> | null

New birth date (ISO 8601 date). Omit to leave unchanged.

is_hidden
boolean | null

Hide or unhide this person. Omit to leave unchanged.

is_favorite
boolean | null

Mark or unmark this person as a favorite. Omit to leave unchanged.

thumbnail_face_id
string | null

New thumbnail face ID for this person. Omit to leave unchanged. Enumerate a person's faces with list_faces and person_id.

Response

Successful Response

Represents a person identified through face clustering and recognition.

id
string
required

Unique person identifier with 'person_' prefix

is_hidden
boolean
required

Whether this person should be hidden from the UI

is_favorite
boolean
required

Whether this person is marked as a favorite

created_at
string<date-time>
required

When this person record was created

updated_at
string<date-time>
required

When this person record was last updated

name
string | null

Optional name assigned to this person

birth_date
string<date> | null

Optional birth date of this person

asset_count
integer | null

Number of unique photos this person appears in, or null if not computed

thumbnail_face_id
string | null

ID of the face resource used as this person's thumbnail

asset_urls
Asset Urls · object | null

Asset variants from this person's thumbnail face. May be null when embedded in an AssetResponse; use /api/people endpoints for full person data.

cluster_metrics
ClusterMetricsResponse · object | null

Cohesion metrics for this person's face cluster. Populated only when include=cluster_metrics is requested on the people endpoint, and only for persons with a populated centroid (newly-created empty Persons will have null). See ClusterMetricsResponse for the shape.