Tags

Create or update multiple tags in a single request.

put/tags

Request

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

Request body

tagsstring[] required

Tag names to upsert

Response

colorstring

Tag color (hex)

createdAtstring date-time required

Creation date

idstring uuid required

Tag ID

namestring required

Tag name

parentIdstring

Parent tag ID

updatedAtstring date-time required

Last update date

valuestring required

Tag value (full path)

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