Preview letter mailing
spur_preview_letter_campaignRequired step before mailing letters. Renders the letter with the first recipient's real data in its letter type's layout, checks which owners have mailing addresses, estimates the cost from the user's plan (Insert Blank Page letters include the extra address page), and returns a confirmation_token.
Show the preview, then ask the user to approve. Only after they approve, call spur_send_letters with the token (the widget's Send button does the same). The token expires in 30 minutes and only covers this exact template, letter type, print options, recipient set and return address.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| color | No | Print in color (false for black and white) | |
| owner_ids | Yes | Owners to mail (spur_find_owners) | |
| template_id | Yes | Letter template id (UUID from a Spur list/search tool) | |
| double_sided | No | Print on both sides of each sheet | |
| return_address_id | No | Defaults to the user's default return address |