Paperless-ngx icon

Paperless-ngx

Consume documents and metadata from Paperless-ngx API

Storage Path → Update a Storage Path

AI-generated

Summary

Update a storage path record with new configuration values.

Inputs

  • id (required) — The numeric ID of the storage path to update.
  • update_fields — A collection of fields to update, such as name, path, matching_algorithm, and match.

Output shape

an updated storage path object

Returns the full storage path resource reflecting the applied changes.

Examples

Example 1: Rename a storage path and adjust its matching settings

id: 12, update_fields: [{name: "name", value: "Important"}, {matching_algorithm: 4}]

Example 2: Change the path template and matching expression

id: 7, update_fields: [{path: "{{year}}/{{type}}"], {match: "\d{4}"}]

Links

Discussion