Create a letter
create_letterCreate and publish an invitation or letter. Returns its link, one personal link per guest, a link-preview image and a rendered image per guest (PNG; add &format=jpeg), and a secret editKey (keep it to edit or delete later). Use {name} in texts to address each guest. Dates are local: "2026-11-14" (whole day) or "2026-11-14T18:00".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Language guests read the letter in | en |
| seal | No | Wax seal mark: "" none, "_" plain, "icon:<id>", "ini:ABC", "duo:A|J" | |
| style | No | Look of the letter and envelope (see catalog.styles) | parchment |
| blocks | No | Letter blocks, top to bottom. Replaces all blocks. Use {name} in text to address each guest. | |
| custom | No | Overrides on top of the style: accent/paper/ink/envelope colours, head/body fonts | |
| guests | No | Each guest gets their own addressed link | |
| preset | No | Start from an occasion preset (pre-filled blocks). On update it only changes the occasion. | |
| envelope | No | Envelope slot blocks, partial like letter blocks (see catalog.envelope for each slot's block type) | |
| sealShape | No | ||
| nameFallback | No | What {name} reads as without a guest (default: "Dear Guest" in the letter language) |