Paperless-ngx icon

Paperless-ngx

Consume documents and metadata from Paperless-ngx API

Tag → Update a Tag

AI-generated

Summary

Update an existing tag's metadata

Inputs

  • id (required) — ID of the tag to update
  • update_fields — Fields to update on the tag, such as name, matching algorithm, and matching expression

Output shape

a single updated tag object

The returned object contains the updated tag's attributes; if validation fails, an error is thrown.

Examples

Example 1: Rename a tag

Select tag by ID, set name to 'Important'

Example 2: Change matching algorithm

Set matching_algorithm to 2 (All) and provide matching expression

Links

Discussion