Sign in
People

Create a person

Changed on

Create a new person that can have multiple faces assigned to them.

post/people

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/people
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Request body

birthDatestring date nullable

Person date of birth

colorstring nullable

Person color (hex)

isFavoriteboolean

Mark as favorite

isHiddenboolean

Person visibility (hidden)

namestring

Person name

Response

birthDatestring date nullable required

Person date of birth

colorstring

Person color (hex)

idstring uuid required

Person ID

isFavoriteboolean

Is favorite

isHiddenboolean required

Is hidden

namestring required

Person name

thumbnailPathstring required

Thumbnail path

updatedAtstring date-time

Last update date

Changes

  • 2cd7bd44a940Revision changes
    • info

      the response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status