update_person
Update person details: name unnamed faces, set birth dates, hide clutter faces, or change thumbnail. Only provided fields are modified.
Instructions
Update a person's profile details. Use this to name unnamed faces, set birth dates, hide clutter faces, or change the representative thumbnail. Only provided fields are modified. Side effect: changes person metadata in Immich.
Args:
person_id: The person's UUID.
name: Display name (e.g. 'John Smith'). Set to name unnamed face clusters.
birth_date: ISO date (e.g. '1990-05-15').
is_hidden: Hide from the People view (useful for strangers/clutter).
is_favorite: Mark as a favorite person.
feature_face_asset_id: Asset UUID whose face crop becomes the person's thumbnail.
color: Hex color label for UI grouping.
Returns: JSON with the updated person object.Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| person_id | Yes | ||
| name | No | ||
| birth_date | No | ||
| is_hidden | No | ||
| is_favorite | No | ||
| feature_face_asset_id | No | ||
| color | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |