Skip to main content
Thanks.io logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 29
  • Triggers: 0
  • Slug: THANKS_IO
  • Version: 20261101_00

Tools

Slug: THANKS_IO_ADD_RECIPIENT_TO_MAILING_LISTTool to add a new recipient to a mailing list. Use after confirming recipient and list IDs.

Input Parameters

string
required
City of the recipient’s address
string
required
Full name of the recipient
string
Recipient’s email address
string
Recipient’s phone number
string
required
Primary street address of the recipient
string
required
Country code of the recipient’s address (ISO 3166-1 alpha-2)
string
Additional address information (e.g., apartment or suite number)
string
required
State or province of the recipient’s address
string
required
Postal or ZIP code of the recipient’s address
string
required
ID of the mailing list to which the recipient will be added

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_CREATE_MAILING_LISTTool to create a new mailing list. Use when you need to group contacts under a fresh list before adding recipients.

Input Parameters

string
required
Name of the new mailing list
string
required
Brief description of the mailing list (required by API)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_DELETE_MAILING_LISTTool to delete a mailing list. Use when you need to remove an entire mailing list by its ID. Confirm the list ID before calling. Example: “Delete the mailing list with ID 123e4567-e89b-12d3-a456-426614174000”.

Input Parameters

string
required
The UUID of the mailing list to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_DELETE_RECIPIENT_FROM_MAILING_LISTTool to remove a recipient from a mailing list. Use after confirming the recipient’s ID.

Input Parameters

string
required
Unique identifier of the recipient to remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_DELETE_SUB_ACCOUNTTool to delete a specific sub-account by ID. Use when you need to remove an existing sub-account. Confirm the ID before calling.

Input Parameters

integer
required
The unique ID of the sub-account to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_EXECUTE_STORED_SENDExecute a previously created stored send to trigger delivery. The tool returns an empty response for HTTP statuses below 400.

Input Parameters

string
required
UUID of the stored send resource to execute
string ("postcard" | "letter" | "windowlessletter" | "notecard" | "giftcard")
required
Type of stored send to execute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_LIST_HANDWRITING_STYLESTool to retrieve available handwriting styles. Use when selecting a style for handwritten personalization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_LIST_IMAGE_TEMPLATESTool to retrieve a list of available image templates. Use when you need to browse or select a template for mailings.

Input Parameters

integer
Page number to retrieve (1-indexed). Defaults to 1.
integer
Number of items to return per page. Default is 25.
integer
Filter results by Sub Account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_LIST_MAILING_LISTSList mailing lists for the account. The tool returns the lists in the API response, which may be a single page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_LIST_MESSAGE_TEMPLATESTool to list available message templates. Use when selecting a template for a mailing.

Input Parameters

integer
Number of items to return per page. Default is 25.
integer
Filter results by Sub Account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_MAILING_LISTS_BUY_RADIUS_SEARCHBuy a targeted mailing list around a specified address or append results to an existing list, using a requested count of nearest records.

Input Parameters

string
required
Full address to use as the center of the radius search
boolean
Append phone and email to each record for an additional fee
string
required
Postal code for the search
integer
required
Number of nearest neighbors to search for (1-10000)
string ("all" | "likelytomove" | "likelytorefi" | "absenteeowner" | "highnetworth" | "majorityhomeequity" | "homefreeclear" | "underwater" | "kidsinhousehold" | "newhomeowner" | "firsttimehomebuyer" | "renters" | "retiring" | "retired" | "pool" | "onlybusinesses" | "newbusiness")
Type of records to search for
boolean
Include condos in search results
integer
Optional ID of existing mailing list to append results to. If not provided, a new list will be created.
boolean
Use property owner’s address when searching for commercial record types

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_ORDER_PREVIEW_LETTERRequest a letter send preview as PDF and return preview URLs. Set preview to true for a preview; false is also accepted and may place an order instead.

Input Parameters

string
Handwritten message content to appear on the letter cover page.
boolean
required
Must be true to generate and return PDF preview URLs instead of placing an order.
array
List of recipients for the letter. Required if mailing_lists not provided.
string
City for the return address.
string
Name to print on the return address block.
string
State or province for the return address.
array
IDs of mailing lists to preview. Required if recipients not provided.
string
Street address line 1 for the return address.
string
Street address line 2 for the return address.
string
URL to a PDF file containing additional pages to include in the letter. Up to 10 pages allowed, printed double-sided.
integer
ID of the handwriting style to use for the letter body.
string
Postal or ZIP code for the return address.
string
URL to the background image for the letter (JPEG/PNG).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_ORDER_PREVIEW_NOTECARDTool to preview a notecard send. Use when you need front and back images before placing an actual notecard order.

Input Parameters

string
required
Handwritten message content to place inside the notecard.
boolean
required
Must be true to return preview images instead of sending.
array
required
List of recipient objects for the notecard preview.
integer
required
ID of a pre-saved notecard image template.
integer
required
ID of the handwriting style to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_ORDER_PREVIEW_WINDOWLESS_LETTERTool to preview a windowless letter send. Use when you need a PDF preview of the cover-only letter before placing an order.

Input Parameters

string
Handwritten message content. Required if ‘message_template’ not set
boolean
required
Must be true to return a PDF preview of the letter send
array
required
List of recipients for the preview send
string
required
URL to the cover image for the windowless letter
string
ID of a stored message template. Required if ‘message’ not set
string
Ink color for handwriting (e.g., ‘blue’,‘black’, or hex code)
string
ID of handwriting style to use
string
URL to a single-page PDF to print on back of cover image

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_ORDERS_LISTTool to list recent orders. Use after placing orders to fetch the latest history, optionally filtering by sub-account or limiting the result count.

Input Parameters

integer
Number of items to return per page (default: 25).
integer
Filter orders by this sub-account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_ORDERS_SEARCH_BY_ADDRESSSearch orders by recipient street address, returning a page of matched order items and orders.

Input Parameters

integer
Page number for paginated results, default is 1.
string
required
Street address to search orders by.
integer
Number of results per page, between 1 and 100, default is 50.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_RECIPIENTS_CREATE_MULTICreate multiple recipients in a mailing list through individual requests. If a request fails, earlier recipients may already have been created.

Input Parameters

string
required
ID of the mailing list to which recipients will be added
array
required
List of recipients to create at once in the mailing list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_RECIPIENTS_DELETE_BY_ADDRESSDelete recipients matching an exact street address and postal code across retrieved mailing lists, without requiring their IDs. Multiple matches may be deleted; list retrieval and individual deletion failures can leave matches undeleted.

Input Parameters

string
required
Full street address of the recipient
string
required
Postal or ZIP code of the recipient’s address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_RECIPIENTS_GET_DETAILSTool to get details for a specific recipient by ID. Use to verify a recipient’s full address and custom fields.

Input Parameters

string
required
Unique identifier of the recipient to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_RECIPIENTS_SEARCH_BY_EMAILSearch recipients by email in specified mailing lists. Returns a page of matching recipients with pagination metadata.

Input Parameters

string
required
Email address to search for.
integer
Maximum number of recipients to return; defaults to server limit if unset.
array
required
Array of mailing list IDs to search in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_RECIPIENTS_UPDATETool to update existing recipient details by recipient ID. Use when modifying recipient data after confirming the recipient exists.

Input Parameters

string
City of the recipient’s address
string
Full name of the recipient
string
Email address of the recipient
string
Phone number of the recipient
string
Primary street address of the recipient
string
Country code of the recipient’s address (ISO 3166-1 alpha-2)
string
Custom field 1 for the recipient
string
Custom field 2 for the recipient
string
Custom field 3 for the recipient
string
Custom field 4 for the recipient
string
Additional address information (e.g., apartment or suite number)
string
State or province of the recipient’s address
string
Postal or ZIP code of the recipient’s address
string
required
Unique identifier of the recipient to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_SEND_POSTCARDSend a customized physical postcard with a chosen image and handwritten message, or request a preview without sending.

Input Parameters

string ("4x6" | "6x9" | "6x11")
Postcard size; defaults to ‘4x6’
string
Handwritten message content (required if ‘message_template’ is not provided)
boolean
If true, returns a preview of the postcard without sending. Useful for validation.
string
URL to auto-generate a QR code on the back of the postcard
array
Explicit recipient objects
string
City for the return address
string
Name for the return address
string
ID of the sub-account to bill this order
string
State for the return address
array
List of mailing-list IDs to send to
Parameters for a radius-based address search.
string
ID of a pre-saved front-image template (required if ‘front_image_url’ is not provided)
string
Street address for the return address
string
URL to the image for the front of the postcard (required if ‘image_template’ is not provided)
string
Additional street address information
string
Email address to receive order alerts (e.g., QR scan notifications)
string
ID of a pre-saved message template (required if ‘message’ is not provided)
string
Handwriting ink color (e.g., ‘blue’, ‘black’, ‘#4287f5’)
string
ID of the handwriting style to use
string
Postal code for the return address
boolean
If true, sends as USPS Standard Mail postage class
boolean
Whether to use a custom background image
string
URL to a custom background image (1875×1275 px)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_STORED_SEND_NOTECARDCreate a stored send for a personalized notecard and return a URL to execute it later.

Input Parameters

string
required
Handwritten message content for the notecard
string
URL to generate a QR code inside the notecard
array
required
List of recipient mailing details
string
ID of the sub-account to use for this order
string
required
URL to the image for the front of the notecard
string
Email to send order alerts (e.g., QR scan notifications)
string
Handwriting color name or hex code
string
ID of the handwriting style to use
boolean
Set to true to send via standard mail postage
boolean
Whether to use a custom background image
string
URL to custom background (1650×2475px required)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_STORED_SEND_POSTCARDCreate a stored send for a postcard and return a URL to finalize and send it later.

Input Parameters

string ("4x6" | "6x9" | "6x11")
Postcard size
string
Handwritten message content
boolean
If true, return preview images instead of scheduling send
string
URL to auto-generate a QR code on back
array
List of recipients
array
List of mailing list IDs
string
ID of front-image template
string
URL to front image
string
ID of message template
string
Handwriting ink color
string
ID of handwriting style to apply
string
URL to custom background image

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_STORED_SEND_WINDOWLESS_LETTERTool to create a stored send for a windowless letter. Use when you need to prepare a letter order for later execution.

Input Parameters

string
required
Handwritten message content
array
required
List of recipients to schedule the stored send for
string
required
URL to the cover image for the windowless letter
integer
required
ID of the handwriting style to use

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_SUB_ACCOUNTS_CREATETool to create a new sub-account. Use when you need to manage separate profiles with distinct return addresses and settings.

Input Parameters

string
required
Name of the sub-account
string
City for the return address (optional)
string
Name for the return address (optional)
string
State for the return address (2-letter code, optional)
string
Primary return street address (optional)
string
Secondary return street address (optional)
string
Postal code for the return address (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_SUB_ACCOUNTS_LISTList up to five sub-accounts for selecting a sub-account context. The result contains only the first five entries returned by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_SUB_ACCOUNTS_SHOWRetrieve details for a specific sub-account by ID, including its name, return address, default envelope and timestamps.

Input Parameters

string
required
Unique identifier of the sub-account to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THANKS_IO_SUB_ACCOUNTS_UPDATETool to update details for a specific sub-account. Use when modifying title or return address details of a sub-account. Confirm sub-account ID before calling.

Input Parameters

string
New name for the sub-account.
string
New city for the return address.
string
New return recipient name.
string
New state/province for the return address (2-letter code).
string
New primary return street address.
string
required
Unique identifier of the sub-account to update.
string
New secondary return address (optional).
string
New postal code for the return address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not