update_mail_account
Update an existing mail account by changing only the fields you provide. Leave the password field empty to keep the current stored credential.
Instructions
Update fields on ONE mail account (PATCH — only fields you supply are changed). Omit password to keep the stored one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | No | ||
| owner | No | ||
| is_token | No | true when `password` is an OAuth/app token | |
| password | No | IMAP password or OAuth token. Write-only: Paperless returns it masked as all asterisks (at least 10, one per character), and sending any all-asterisks value back leaves the stored password unchanged. | |
| username | No | ||
| imap_port | No | Usually 993 (SSL) or 143 (STARTTLS / none) | |
| imap_server | No | ||
| account_type | No | 1=IMAP, 2=Gmail OAuth, 3=Outlook OAuth | |
| character_set | No | e.g. UTF-8 (default) or US-ASCII | |
| imap_security | No | 1=no encryption, 2=SSL, 3=STARTTLS |