Sign in
people

Update a person

Updates a person's name, birth date, visibility, or thumbnail. Only the fields included in the request body are changed. Typical use: assigning a name ('name this face cluster "Alice"') or choosing a better thumbnail.

This tool does not move faces between people — use update_face with a new person_id for that.

patch/api/people/{person_id}

Path parameters

person_idstring required

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

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

Request body

namestring nullable

New display name. Omit to leave unchanged.

birth_datestring date nullable

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

is_hiddenboolean nullable

Hide or unhide this person. Omit to leave unchanged.

is_favoriteboolean nullable

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

thumbnail_face_idstring nullable

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

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

Changes

Changed in 3 of the 79 revisions of this API.115

  • 815e0302a98811See the full diff
    • ▲

      response property detail list-of-types was widened by adding types string to media type application/json of response 422

      response-property-list-of-types-widened

    • ○

      the response property became required for the status

      response-property-became-required

  • c3e15c78f2da4See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 0de36cb170df1See the full diff
    • ●

      the / request property's maxLength was set to 255

      request-property-max-length-set