thanks.io icon

thanks.io

Interact with thanks.io API

Mailer → Send Magnacard

AI-generated

Summary

Send a magnet-style mailer called a Magnacard through thanks.io to recipients specified by mailing lists, direct recipient details, or by radius search near an address.

Inputs

  • authentication — Select authentication method; only Personal Access Tokens (API Key) is provided.
  • audienceType (required) — Specify how to determine recipients for the Magnacard order: from existing mailing lists, direct recipient entries, or a radius search around an address.
  • mailingListIds (required) — When 'Mailing Lists' audience is chosen, specify one or more mailing list IDs to send the Magnacard to.
  • recipientsCollection (required) — When 'Recipients' audience is chosen, provide one or more recipient details including name, company, street address (address and address 2), city, state/province, postal code, country, email, phone, date of birth, and up to four custom fields.
  • radiusSearch (required) — When 'Radius Search' audience is chosen, provide parameters including address (required), number of records, record types, and options like appending phone/email, including condos or the search address, and whether to preview results without sending.
  • image_template_id — ID of the image template to use for the Magnacard front; required if front image URL is not provided. Use 0 to omit.
  • front_image_url — URL of the front image for the Magnacard; required if image template ID is not provided.
  • message — Handwritten message content for the Magnacard. Supports placeholders like %FIRST_NAME% for personalization.
  • message_template_id — ID of a predefined message template to use. Use 0 to omit.
  • use_custom_background — Boolean flag to enable a custom background image, which overrides the default background for the Magnacard.
  • custom_background_image — URL to a custom background image placed behind the handwritten message.
  • additionalFields — Additional optional fields including handwriting color, handwriting realism, handwriting style ID, notification emails, preview flag, return address details, postage type (Standard Mail), and sub-account ID.

Output shape

a single JSON object with response details from the thanks.io API representing the order status or preview data

Returns full API response JSON indicating success, errors, or preview data if 'Preview' option is used. Errors are reported per item if continueOnFail is enabled.

Links

Discussion