Merge people

Merges one or more source people into the primary person identified by the URL. All faces from source people are reassigned to the primary person. Source people are permanently deleted (this cannot be undone). The primary person's centroid embedding is recalculated.

In the degenerate case where the primary and all sources are unnamed and have zero faces, the primary is auto-deleted by the post-merge centroid recompute and the response is 204 No Content.

person_idstring required

Person ID (with person_ prefix) of the primary person that absorbs the source people. Person IDs are carried by the id field of person responses (e.g. list_people, get_person) and by person references on faces and assets.

Request body

source_person_idsstring[] required

IDs of the people to merge into the primary person. These people will be deleted after their faces are moved.

Response

Successful Response

idstring required

Unique person identifier with 'person_' prefix

namestring nullable

Optional name assigned to this person

birth_datestring date nullable

Optional birth date of this person

is_hiddenboolean required

Whether this person should be hidden from the UI

is_favoriteboolean required

Whether this person is marked as a favorite

asset_countinteger nullable

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

thumbnail_face_idstring nullable

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

asset_urlsobject nullable

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

created_atstring date-time required

When this person record was created

updated_atstring date-time required

When this person record was last updated

v72

Merge people

Path parameters

Request body

Response