Create correspondent
create_correspondentCreate a new correspondent in Paperless-ngx. Avoid duplicates by listing existing correspondents first.
Instructions
Create a new correspondent. Check list_correspondents first: near-duplicate entries are hard to merge later.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Display name. Must be unique. | |
| match | No | Text this object matches against, interpreted per matching_algorithm. | |
| owner | No | Owning user ID, or null for unowned. | |
| is_insensitive | No | Case-insensitive matching. Defaults to true. | |
| set_permissions | No | Object-level permissions. Overwrites existing permissions entirely unless the endpoint supports merging. | |
| matching_algorithm | No | Matching algorithm: 0=none, 1=any word, 2=all words, 3=exact, 4=regex, 5=fuzzy, 6=auto. Use 6 (auto) unless the user asked for a specific rule. |