Sign in
People

Update people

Changed on

Bulk update multiple people at once.

put/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

Response

error'duplicate' | 'no_permission' | 'not_found' | 'unknown' | 'validation'

Error reason

errorMessagestring
idstring uuid required

ID

successboolean required

Whether operation succeeded

Changes

  • 2cd7bd44a940Revision changes
    • breaking

      added the 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})$ to the request property //

    • breaking

      the // request property format changed from no format to uuid

    • 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