Save a whole message in the archive
Files one whole message — its id from email_search or email_get — as a document in the archive (Archivio), where it can be preserved (conservazione a norma). Needed only for a mailbox whose «Salva tutti i messaggi in Archivio» is off (messages_to_documents: false in email_list_accounts): there email_get reports archive_state: "skipped". Every other message is filed automatically, and calling this for it returns that document with created: false. For a sent PEC its ricevute (accettazione, consegna) are filed beside it unless include_receipts is false. Nothing is downloaded or re-uploaded. ⚠ A message in the archive is a record: after 24 hours it can no longer be removed, so file only what the user asked for. A caller who is not an admin needs the mailbox among their Archivio-visible mailboxes, or it fails with PERMISSION_DENIED and details.sourcePartition — do not retry; an administrator assigns the mailbox.
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/email/messages/{id}/archive
- Auth: HTTP bearer
Path parameters
The message id.
Headers
The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.
Request body
Response
Done. data is the tool’s own answer.
Changes
No recorded changes to this operation across all 1 revision of this API.