thanks.io icon

thanks.io

Interact with thanks.io API

Actions7

Mailer → Send Windowed Letter

AI-generated

Summary

Send a windowed letter mailer via thanks.io, specifying recipients by mailing lists, direct input, or radius search around an address, and customize the letter's front image, message, QR code, and additional content.

Inputs

  • Authentication (required) — Personal Access Tokens (API Key) to authenticate the request.
  • Audience (required) — Choose how to specify recipients: an existing mailing list, directly entered recipients, or a radius search near an address.
  • Mailing Lists (required) — When using mailing lists, provide one or more mailing list IDs to target recipients from.
  • Recipients (required) — When specifying recipients directly, provide one or more recipient records including name, address, and optional contact details and custom fields.
  • Radius Search (required) — When using radius search, provide a central address and parameters such as record count and types to buy a list of recipients near that location.
  • Image Template ID — ID of the image template for the letter background; required if Front Image URL is not provided.
  • Front Image URL — URL of the image for the letter background; required if Image Template ID is 0.
  • Message — Handwritten message content to appear on the letter, supporting placeholders for personalization.
  • Message Template ID — ID of a message template to use instead of a custom message.
  • QR Code URL — URL to generate a QR code on the letter; if not specified, the account default is used.
  • Additional Pages URL — URL to PDF pages included with the cover letter.
  • PDF Only URL — URL to a PDF file to use for the entire mailer, which replaces the cover letter.
  • Additional Fields — Extra customization options including handwriting color and style, notification emails, return address details, postage type, sub-account ID, and preview mode.

Output shape

a single JSON object representing the order response from the thanks.io API

The response contains order confirmation details or preview data if preview mode is enabled. Errors are returned in the node execution error handling or as part of the output item if the node is configured to continue on failure.

Examples

Example 1: Send a windowed letter to recipients from specified mailing lists with a custom background and a personalized handwritten message.

Set Authentication with API key. Choose Audience as mailingLists and select one or more existing mailing list IDs. Specify Image Template ID or Front Image URL. Provide a handwritten message with placeholders like %FIRST_NAME%. Optionally add QR Code URL and additional pages URL. Optionally enable preview to test without sending.

Example 2: Send a windowed letter to direct recipients by specifying name and address data.

Set Authentication with API key. Choose Audience as recipients and provide at least one recipient with required address fields. Specify message or message template ID, and front image or image template ID. Optionally include QR code and customize appearance settings.

Example 3: Send a windowed letter to a purchased list of recipients near a given address using radius search.

Set Authentication with API key. Choose Audience as radiusSearch, entering a full address as the search center. Set parameters like record count, record types, whether to append contact data, and preview option. Set creative options and additional fields as needed.

Links

Discussion