Thanks Io

Learn how to use Thanks Io with Composio

Overview

SLUG

THANKS_IO

Description

thanks.io is a direct mail automation platform that enables users to send personalized postcards, letters, and notecards with handwritten fonts.

Authentication Details

generic_api_key
stringRequired

Tools

SLUG: THANKS_IO_ADD_RECIPIENT_TO_MAILING_LIST

Tool to add a new recipient to a mailing list. use after confirming recipient and list ids.

Action Parameters

address
stringRequired
address2
string
city
stringRequired
country
stringRequired
email
mailing_list
stringRequired
name
stringRequired
phone
string
postal_code
stringRequired
province
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_CREATE_MAILING_LIST

Tool to create a new mailing list. use when you need to group contacts under a fresh list before adding recipients.

Action Parameters

description
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_DELETE_MAILING_LIST

Tool 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".

Action Parameters

list_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_DELETE_RECIPIENT_FROM_MAILING_LIST

Tool to remove a recipient from a mailing list. use after confirming the recipient's id.

Action Parameters

recipient_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_DELETE_SUB_ACCOUNT

Tool to delete a specific sub-account by id. use when you need to remove an existing sub-account. confirm the id before calling.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_EXECUTE_STORED_SEND

Tool to execute a previously created stored send. use after creating a stored send to trigger delivery. the response body is empty; success is indicated by a 200 or 204 status.

Action Parameters

send_type
stringRequired
uuid
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_LIST_HANDWRITING_STYLES

Tool to retrieve available handwriting styles. use when selecting a style for handwritten personalization.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_LIST_IMAGE_TEMPLATES

Tool to retrieve a list of available image templates. use when you need to browse or select a template for mailings.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_LIST_MAILING_LISTS

Tool to list all mailing lists. use when you need to fetch existing lists before managing recipients.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_LIST_MESSAGE_TEMPLATES

Tool to list available message templates. use when selecting a template for a mailing.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_MAILING_LISTS_BUY_RADIUS_SEARCH

Tool to buy or append a radius search mailing list based on address and radius. use when you need targeted mailing lists around a specified address.

Action Parameters

address
stringRequired
append_data
boolean
include_condos
booleanDefaults to True
postal_code
stringRequired
preview
boolean
record_count
integerRequired
record_types
stringDefaults to all
use_property_owner
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_ORDERS_LIST

Tool to list recent orders. use after placing orders to fetch the latest history, optionally filtering by sub-account or limiting the result count.

Action Parameters

limit
integer
sub_account_id
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
meta
objectRequired
successful
booleanRequired

SLUG: THANKS_IO_ORDERS_SEARCH_BY_ADDRESS

Tool to search orders by recipient street address. use when you need to find all orders sent to a specific street address.

Action Parameters

address
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_ORDERS_SEARCH_BY_NAME

Tool to search orders by recipient full name. use when you need to find all orders sent to a specific recipient.

Action Parameters

full_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_ORDERS_STATS

Tool to retrieve order summary statistics for a date range. use when analyzing order volume and value filtered by type, status, or date range.

Action Parameters

end_date
string
start_date
string
status
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_ORDER_PREVIEW_LETTER

Tool to preview a letter send as pdf. use when you need to confirm letter content before placing the final order. returns pdf preview urls.

Action Parameters

additional_pages_url
string
front_image_url
stringRequired
handwriting_style
integer
mailing_lists
array
message
string
preview
booleanRequired
return_address
string
return_address2
string
return_city
string
return_name
string
return_postal_code
string
return_state
string

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
success
booleanRequired
successful
booleanRequired

SLUG: THANKS_IO_ORDER_PREVIEW_NOTECARD

Tool to preview a notecard send. use when you need front and back images before placing an actual notecard order.

Action Parameters

handwriting_style
integerRequired
image_template
integerRequired
message
stringRequired
preview
booleanRequired
recipients
arrayRequired

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
success
booleanRequired
successful
booleanRequired

SLUG: THANKS_IO_ORDER_PREVIEW_POSTCARD

Tool to preview a postcard send. use when you need front and back images before placing an order.

Action Parameters

front_image_url
handwriting_color
string
handwriting_style
string
image_template
string
mailing_lists
array
message
string
message_template
string
preview
booleanRequired
qrcode_url
recipients
array
size
stringDefaults to 4x6

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
success
booleanRequired
successful
booleanRequired

SLUG: THANKS_IO_ORDER_PREVIEW_WINDOWLESS_LETTER

Tool to preview a windowless letter send. use when you need a pdf preview of the cover-only letter before placing an order.

Action Parameters

additional_pages_url
front_image_url
Required
handwriting_color
string
handwriting_style
string
message
string
message_template
string
preview
booleanRequired
recipients
arrayRequired

Action Response

code
integerRequired
data
objectRequired
error
string
message
stringRequired
success
booleanRequired
successful
booleanRequired

SLUG: THANKS_IO_PROOF_POSTCARD

Tool to generate a pdf proof of a postcard's front and back. use when you need a preview pdf before sending the final postcard.

Action Parameters

back_image_html_content
string
back_image_html_url
back_image_url
custom_background_image
front_image_html_content
string
front_image_html_url
front_image_url
handwriting_color
string
handwriting_style
integer
message
string
nostamp
boolean
qrcode_url
return_address
string
return_address2
string
return_city
string
return_name
string
return_postal_code
string
return_state
string
size
stringDefaults to 4x6
to_address
stringRequired
to_address2
string
to_city
stringRequired
to_country
stringRequired
to_name
stringRequired
to_postal_code
stringRequired
to_state
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_RECIPIENTS_CREATE_MULTI

Tool to create multiple recipients at once in a mailing list. use when batching recipient additions for efficiency.

Action Parameters

list_id
stringRequired
recipients
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_RECIPIENTS_DELETE_BY_ADDRESS

Tool to delete a recipient by address and postal code. use when you need to remove a recipient without their id.

Action Parameters

address
stringRequired
postal_code
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_RECIPIENTS_GET_DETAILS

Tool to get details for a specific recipient by id. use to verify a recipient’s full address and custom fields.

Action Parameters

recipient_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_RECIPIENTS_SEARCH_BY_EMAIL

Tool to search recipients by email across mailing lists. use when you need to find all recipients matching an email in specific lists. example: "find recipients with email test@test.com in lists [1,2,3]."

Action Parameters

email
stringRequired
limit
integer
mailing_list_ids
arrayRequired

Action Response

current_page
integerRequired
data
arrayRequired
error
string
first_page_url
stringRequired
from
integerRequired
last_page
integerRequired
last_page_url
stringRequired
next_page_url
string
path
stringRequired
per_page
integerRequired
prev_page_url
string
successful
booleanRequired
to
integerRequired
total
integerRequired

SLUG: THANKS_IO_RECIPIENTS_UPDATE

Tool to update existing recipient details by recipient id. use when modifying recipient data after confirming the recipient exists.

Action Parameters

address
string
address2
string
city
string
country
string
custom1
string
custom2
string
custom3
string
custom4
string
email
name
string
phone
string
postal_code
string
province
string
recipient_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_SEND_POSTCARD

Tool to send a customized postcard. use when you need to dispatch a physical postcard with a chosen image and handwritten message.

Action Parameters

custom_background_image
email_additional
front_image_url
handwriting_color
string
handwriting_style
string
image_template
string
mailing_lists
array
message
string
message_template
string
qrcode_url
radius_search
object
recipients
array
return_address
object
send_standard_mail
boolean
size
stringDefaults to 4x6
sub_account
string
use_custom_background
boolean

Action Response

data
object
error
string
message
string
status
string
successful
booleanRequired

SLUG: THANKS_IO_STORED_SEND_NOTECARD

Tool to create a stored send for a notecard. use when you need to schedule mailing of a personalized notecard at a later time after preparing payload.

Action Parameters

custom_background_image
email_additional
front_image_url
Required
handwriting_color
handwriting_style
string
message
stringRequired
qrcode_url
recipients
arrayRequired
send_standard_mail
boolean
sub_account
string
use_custom_background
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_STORED_SEND_POSTCARD

Tool to create a stored send for a postcard. use when you need to prepare and schedule postcard orders for later execution; returns a url to finalize and send.

Action Parameters

custom_background_image
string
front_image_url
string
handwriting_color
string
handwriting_style
string
image_template
string
mailing_lists
array
message
string
message_template
string
preview
boolean
qrcode_url
string
recipients
array
size
stringDefaults to 4x6

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_STORED_SEND_WINDOWLESS_LETTER

Tool to create a stored send for a windowless letter. use when you need to prepare a letter order for later execution.

Action Parameters

front_image_url
Required
handwriting_style
integerRequired
message
stringRequired
recipients
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_SUB_ACCOUNTS_CREATE

Tool to create a new sub-account. use when you need to manage separate profiles with distinct return addresses and settings.

Action Parameters

return_address
stringRequired
return_address2
string
return_city
stringRequired
return_name
stringRequired
return_postal_code
stringRequired
return_state
stringRequired
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_SUB_ACCOUNTS_LIST

Tool to list all available sub-accounts. use when you need to select a sub-account for operations requiring a sub-account context.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_SUB_ACCOUNTS_SHOW

Tool to retrieve details for a specific sub-account by id. use when you need full configuration of a sub-account before performing sub-account scoped operations.

Action Parameters

sub_account_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: THANKS_IO_SUB_ACCOUNTS_UPDATE

Tool 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.

Action Parameters

return_address
string
return_address2
string
return_city
string
return_name
string
return_postal_code
string
return_state
string
sub_account_id
stringRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired