Retained content

Retained content is sent to a recipient who is not yet a Kivra user. Kivra delivers it when the recipient registers, or deletes it when the retention period expires. The same request attributes are used as for normal content, with retain: true enabling the retain-or-deliver behaviour.

Kivra first checks whether the recipient exists. Existing recipients receive the content immediately; otherwise Kivra retains it for the requested period. The default retention period is 30 days. Set retention_time to "30" or "390" when a different supported period is needed.

Only letter.creditnotice, letter.salary, salaryslip, letter.signed, and invite.sign support retained delivery. Other content types return HTTP 422 when retain is enabled.

See the Send content API reference for the complete request schema and validation rules.