Paperless-ngx icon

Paperless-ngx

Consume documents and metadata from Paperless-ngx API

Correspondent → Create a Correspondent

AI-generated

Summary

Create a correspondent in Paperless-ngx with a required name and a configurable document matching algorithm. For algorithms that use an expression, provide the matching expression as well.

Inputs

  • Name (required) — Name of the correspondent to create.
  • Matching Algorithm — Select how Paperless-ngx matches documents to this correspondent. Options are None, Any, All, Exact, Regular Expression, Fuzzy, and Auto; defaults to Auto.
  • Matching Expression — Expression used for matching when the selected algorithm is Any, All, Exact, Regular Expression, or Fuzzy. Hidden for None and Auto.

Output shape

A single correspondent record

The source pack contains only the operation signature, so it does not reveal the exact response fields or return handling.

Links

Discussion