thanks.io icon

thanks.io

Interact with thanks.io API

Actions7

Mailer → Send Giftcard

AI-generated

Summary

Send a giftcard mailer to recipients specified via mailing lists, direct recipient details, or a radius-based search around an address.

Inputs

  • Authentication (required) — Select the authentication method, currently supporting Personal Access Tokens (API Key).
  • Audience (required) — Choose how to specify recipients: by existing mailing lists, direct input of recipient details, or by a radius search near an address.
  • Mailing Lists — Specify one or more existing mailing list IDs to send the giftcard to (required if Audience is Mailing Lists).
  • Recipients — Provide one or more recipient details directly including name, company, address, city, state/province, postal code, country, email, phone, date of birth, and custom fields (required if Audience is Recipients).
  • Radius Search — Configure a radius-based search centered on a given address to buy a nearby recipient list with options like including condos, appending phone/email, record count, record types, and preview without purchase (required if Audience is Radius Search).
  • Giftcard Brand (required) — Select the brand of giftcard to send from a searchable list or provide a brand code.
  • Giftcard Amount (required) — Select the giftcard amount available for the brand or specify an amount in cents.
  • Image Template ID — ID of the image template to use for the front or background of the mailer. Required if Front Image URL is not provided. Use 0 to omit.
  • Front Image URL — URL of the image to use for the front of the mailer or background for letters. Required if Image Template ID is 0 or not provided.
  • Message — Handwritten message content for the mailer with support for placeholders like %FIRST_NAME% for personalization.
  • Message Template ID — ID of the message template to use. Use 0 to omit.
  • Additional Fields — Additional optional parameters such as handwriting color, handwriting realism effect, handwriting style ID, notification emails, preview flag, return address details, postage type (standard or first class), and sub-account ID.

Output shape

A single record JSON object representing the API response for the giftcard send order, including order status and details.

No pagination applies. The response includes confirmation data from the thanks.io API after placing the giftcard order. If the preview option is enabled, the response contains a preview of the mail piece without placing the order. Errors are returned as a JSON object with error message.

Examples

Example 1: Send a giftcard to recipients in specific mailing lists

Set Authentication to API Key; Audience to Mailing Lists; select one or more mailing list IDs; specify giftcard brand and amount; optionally set message and templates.

Example 2: Send a giftcard to direct recipient details

Set Audience to Recipients; input one or more recipient records with name and address details; specify giftcard brand and amount; optionally add message content.

Example 3: Send a giftcard using radius search

Set Audience to Radius Search; provide a full address and search parameters; optionally enable preview; specify giftcard brand and amount.

Links

Discussion