Create a tag, correspondent or type
paperless_create_objectCreate tags, correspondents, document types, storage paths, or custom fields in paperless-ngx. Configure matching algorithm, colors, paths, or data types for automated document classification.
Instructions
Create a tag, correspondent, document type, storage path or custom field. Matching algorithm: 0 none, 1 any word, 2 all words, 3 exact, 4 regex, 5 fuzzy, 6 auto (trained classifier). Storage paths need a path template such as {{ created_year }}/{{ correspondent }}/{{ title }}. Custom fields need a data_type (string, url, date, boolean, integer, float, monetary, documentlink, select).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the new object. | |
| path | No | Storage paths only: the filename template. | |
| type | Yes | What to create. | |
| match | No | Match text or pattern used for automatic assignment. | |
| colour | No | Tags only: hex colour such as `#a6cee3`. | |
| data_type | No | Custom fields only: the value type. | |
| extra_data | No | Custom fields only, e.g. `{"select_options":[{"label":"Cat"},{"label":"Dog"}]}`. | |
| is_inbox_tag | No | Tags only: mark newly consumed documents with this tag. | |
| is_insensitive | No | Case-insensitive matching. Defaults to true server-side. | |
| matching_algorithm | No | Matching algorithm: 0 none, 1 any word, 2 all words, 3 exact, 4 regex, 5 fuzzy, 6 auto (trained classifier). |