Thanks.io
thanks_iothanks.io is a direct mail automation platform that enables users to send personalized postcards, letters, and notecards with handwritten fonts.
Acciones disponibles (33)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Recipient to Mailing ListTHANKS_IO_ADD_RECIPIENT_TO_MAILING_LISTAcciónTool to add a new recipient to a mailing list. use after confirming recipient and list ids.
THANKS_IO_ADD_RECIPIENT_TO_MAILING_LISTAcciónTool to add a new recipient to a mailing list. use after confirming recipient and list ids.
Parámetros de entrada
citystringObligatorioCity of the recipient's address
namestringObligatorioFull name of the recipient
emailanyemailRecipient's email address
phonestringRecipient's phone number
addressstringObligatorioPrimary street address of the recipient
countrystringObligatorioCountry code of the recipient's address (ISO 3166-1 alpha-2)
address2stringAdditional address information (e.g., apartment or suite number)
provincestringObligatorioState or province of the recipient's address
postal_codestringObligatorioPostal or ZIP code of the recipient's address
mailing_liststringObligatorioID of the mailing list to which the recipient will be added
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Mailing ListTHANKS_IO_CREATE_MAILING_LISTAcciónTool to create a new mailing list. use when you need to group contacts under a fresh list before adding recipients.
THANKS_IO_CREATE_MAILING_LISTAcciónTool to create a new mailing list. use when you need to group contacts under a fresh list before adding recipients.
Parámetros de entrada
namestringObligatorioName of the new mailing list
descriptionstringBrief description of the mailing list
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Mailing ListTHANKS_IO_DELETE_MAILING_LISTAcciónTool 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".
THANKS_IO_DELETE_MAILING_LISTAcciónTool 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".
Parámetros de entrada
list_idstringObligatorioThe UUID of the mailing list to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Recipient from Mailing ListTHANKS_IO_DELETE_RECIPIENT_FROM_MAILING_LISTAcciónTool to remove a recipient from a mailing list. use after confirming the recipient's id.
THANKS_IO_DELETE_RECIPIENT_FROM_MAILING_LISTAcciónTool to remove a recipient from a mailing list. use after confirming the recipient's id.
Parámetros de entrada
recipient_idstringObligatorioUnique identifier of the recipient to remove
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Sub-AccountTHANKS_IO_DELETE_SUB_ACCOUNTAcciónTool to delete a specific sub-account by id. use when you need to remove an existing sub-account. confirm the id before calling.
THANKS_IO_DELETE_SUB_ACCOUNTAcciónTool to delete a specific sub-account by id. use when you need to remove an existing sub-account. confirm the id before calling.
Parámetros de entrada
idintegerObligatorioThe unique ID of the sub-account to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Execute Stored SendTHANKS_IO_EXECUTE_STORED_SENDAcciónTool 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.
THANKS_IO_EXECUTE_STORED_SENDAcciónTool 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.
Parámetros de entrada
uuidanyObligatoriouuidUUID of the stored send resource to execute
send_typestringObligatorioenumType of stored send to execute
postcardletterwindowlessletternotecardgiftcard
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Handwriting StylesTHANKS_IO_LIST_HANDWRITING_STYLESAcciónTool to retrieve available handwriting styles. use when selecting a style for handwritten personalization.
THANKS_IO_LIST_HANDWRITING_STYLESAcciónTool to retrieve available handwriting styles. use when selecting a style for handwritten personalization.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Image TemplatesTHANKS_IO_LIST_IMAGE_TEMPLATESAcciónTool to retrieve a list of available image templates. use when you need to browse or select a template for mailings.
THANKS_IO_LIST_IMAGE_TEMPLATESAcciónTool to retrieve a list of available image templates. use when you need to browse or select a template for mailings.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Mailing ListsTHANKS_IO_LIST_MAILING_LISTSAcciónTool to list all mailing lists. use when you need to fetch existing lists before managing recipients.
THANKS_IO_LIST_MAILING_LISTSAcciónTool to list all mailing lists. use when you need to fetch existing lists before managing recipients.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Message TemplatesTHANKS_IO_LIST_MESSAGE_TEMPLATESAcciónTool to list available message templates. use when selecting a template for a mailing.
THANKS_IO_LIST_MESSAGE_TEMPLATESAcciónTool to list available message templates. use when selecting a template for a mailing.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Buy Radius Search Mailing ListTHANKS_IO_MAILING_LISTS_BUY_RADIUS_SEARCHAcciónTool 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.
THANKS_IO_MAILING_LISTS_BUY_RADIUS_SEARCHAcciónTool 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.
Parámetros de entrada
addressstringObligatorioFull address to use as the center of the radius search
previewbooleanReturn a preview of the number of neighbors found and cost
append_databooleanAppend phone and email to each record for an additional fee
postal_codestringObligatorioPostal code for the search
record_countintegerObligatorioNumber of nearest neighbors to search for (1-10000)
record_typesstringenumType of records to search for
alllikelytomovelikelytorefiabsenteeownerhighnetworthmajorityhomeequityhomefreeclearunderwaterkidsinhouseholdnewhomeownerfirsttimehomebuyerrenters+5include_condosbooleanInclude condos in search results
use_property_ownerbooleanUse property owner's address when searching for commercial record types
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview letter sendTHANKS_IO_ORDER_PREVIEW_LETTERAcciónTool to preview a letter send as pdf. use when you need to confirm letter content before placing the final order. returns pdf preview urls.
THANKS_IO_ORDER_PREVIEW_LETTERAcciónTool to preview a letter send as pdf. use when you need to confirm letter content before placing the final order. returns pdf preview urls.
Parámetros de entrada
messagestringHandwritten message content to appear on the letter cover page.
previewbooleanObligatorioMust be true to generate and return PDF preview URLs instead of placing an order.
return_citystringCity for the return address.
return_namestringName to print on the return address block.
return_statestringState or province for the return address.
mailing_listsinteger[]IDs of mailing lists to preview. Required if recipients not provided.
return_addressstringStreet address line 1 for the return address.
front_image_urlstringObligatoriouriURL to the cover image for the front of the letter (JPEG/PNG).
return_address2stringStreet address line 2 for the return address.
handwriting_styleintegerID of the handwriting style to use for the letter body.
return_postal_codestringPostal or ZIP code for the return address.
additional_pages_urlstringuriURL to a PDF file containing additional pages to include in the letter. Up to 10 pages allowed, printed double-sided.
Parámetros de salida
codeintegerObligatorioHTTP status code of the preview call.
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
messagestringObligatorioStatus message from the API.
successbooleanObligatorioWhether the preview request succeeded.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview NotecardTHANKS_IO_ORDER_PREVIEW_NOTECARDAcciónTool to preview a notecard send. use when you need front and back images before placing an actual notecard order.
THANKS_IO_ORDER_PREVIEW_NOTECARDAcciónTool to preview a notecard send. use when you need front and back images before placing an actual notecard order.
Parámetros de entrada
messagestringObligatorioHandwritten message content to place inside the notecard.
previewbooleanObligatorioMust be true to return preview images instead of sending.
recipientsobject[]ObligatorioList of recipient objects for the notecard preview.
image_templateintegerObligatorioID of a pre-saved notecard image template.
handwriting_styleintegerObligatorioID of the handwriting style to use.
Parámetros de salida
codeintegerObligatorioHTTP status code returned by the API.
dataobjectObligatorioContainer for preview image URLs.
errorstringError if any occurred during the execution of the action
messagestringObligatorioResult message from the API.
successbooleanObligatorioIndicates whether the preview request succeeded.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview PostcardTHANKS_IO_ORDER_PREVIEW_POSTCARDAcciónTool to preview a postcard send. use when you need front and back images before placing an order.
THANKS_IO_ORDER_PREVIEW_POSTCARDAcciónTool to preview a postcard send. use when you need front and back images before placing an order.
Parámetros de entrada
sizestringenumPostcard size; defaults to '4x6'. Only valid for postcards.
4x66x96x11messagestringHandwritten message content. Required if 'message_template' not provided.
previewbooleanObligatorioMust be true to return preview images.
qrcode_urlanyuriURL to auto-generate QR code on the back of the postcard.
recipientsobject[]Explicit recipient objects.
mailing_listsstring[]List of mailing-list IDs to send to.
image_templatestringID of a pre-saved front-image template. Required if 'front_image_url' not provided.
front_image_urlanyuriURL to the image for the front of the postcard. Required if 'image_template' not provided.
message_templatestringID of pre-saved message template. Required if 'message' not provided.
handwriting_colorstringHandwriting ink color (e.g. 'blue', 'black', '#4287f5').
handwriting_stylestringID of the handwriting style to use.
Parámetros de salida
codeintegerObligatorioHTTP status code returned.
dataobjectObligatorioPreview data containing images.
errorstringError if any occurred during the execution of the action
messagestringObligatorioResult message.
successbooleanObligatorioIndicates request success.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview Windowless LetterTHANKS_IO_ORDER_PREVIEW_WINDOWLESS_LETTERAcciónTool to preview a windowless letter send. use when you need a pdf preview of the cover-only letter before placing an order.
THANKS_IO_ORDER_PREVIEW_WINDOWLESS_LETTERAcciónTool to preview a windowless letter send. use when you need a pdf preview of the cover-only letter before placing an order.
Parámetros de entrada
messagestringHandwritten message content. Required if 'message_template' not set
previewbooleanObligatorioMust be true to return a PDF preview of the letter send
recipientsobject[]ObligatorioList of recipients for the preview send
front_image_urlanyObligatoriouriURL to the cover image for the windowless letter
message_templatestringID of a stored message template. Required if 'message' not set
handwriting_colorstringInk color for handwriting (e.g., 'blue','black', or hex code)
handwriting_stylestringID of handwriting style to use
additional_pages_urlanyuriURL to a single-page PDF to print on back of cover image
Parámetros de salida
codeintegerObligatorioHTTP status code returned by the API
dataobjectObligatorioPreview data containing PDF URLs
errorstringError if any occurred during the execution of the action
messagestringObligatorioResult message from the API
successbooleanObligatorioIndicates if the preview request succeeded
successfulbooleanObligatorioWhether or not the action execution was successful or not
List OrdersTHANKS_IO_ORDERS_LISTAcciónTool to list recent orders. use after placing orders to fetch the latest history, optionally filtering by sub-account or limiting the result count.
THANKS_IO_ORDERS_LISTAcciónTool to list recent orders. use after placing orders to fetch the latest history, optionally filtering by sub-account or limiting the result count.
Parámetros de entrada
limitintegerMaximum number of orders to return (1-100).
sub_account_idintegerFilter orders by this sub-account ID.
Parámetros de salida
dataobject[]ObligatorioList of order summaries.
metaobjectObligatorioPagination metadata.
errorstringError if any occurred during the execution of the action
linksobjectObligatorioPagination link URLs.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search Orders by Recipient Street AddressTHANKS_IO_ORDERS_SEARCH_BY_ADDRESSAcciónTool to search orders by recipient street address. use when you need to find all orders sent to a specific street address.
THANKS_IO_ORDERS_SEARCH_BY_ADDRESSAcciónTool to search orders by recipient street address. use when you need to find all orders sent to a specific street address.
Parámetros de entrada
pageintegerPage number for paginated results, default is 1.
addressstringObligatorioStreet address to search orders by.
per_pageintegerNumber of results per page, between 1 and 100, default is 50.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search Orders by Recipient Full NameTHANKS_IO_ORDERS_SEARCH_BY_NAMEAcciónTool to search orders by recipient full name. use when you need to find all orders sent to a specific recipient.
THANKS_IO_ORDERS_SEARCH_BY_NAMEAcciónTool to search orders by recipient full name. use when you need to find all orders sent to a specific recipient.
Parámetros de entrada
full_namestringObligatorioFull name of the recipient to search orders by.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Order Summary StatisticsTHANKS_IO_ORDERS_STATSAcciónTool to retrieve order summary statistics for a date range. use when analyzing order volume and value filtered by type, status, or date range.
THANKS_IO_ORDERS_STATSAcciónTool to retrieve order summary statistics for a date range. use when analyzing order volume and value filtered by type, status, or date range.
Parámetros de entrada
typestringFilter by order type (e.g., 'postcard', 'letter')
statusstringFilter by order status (e.g., 'pending', 'completed')
end_datestringEnd date for statistics (YYYY-MM-DD)
start_datestringStart date for statistics (YYYY-MM-DD)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Proof PostcardTHANKS_IO_PROOF_POSTCARDAcciónTool to generate a pdf proof of a postcard's front and back. use when you need a preview pdf before sending the final postcard.
THANKS_IO_PROOF_POSTCARDAcciónTool to generate a pdf proof of a postcard's front and back. use when you need a preview pdf before sending the final postcard.
Parámetros de entrada
sizestringenumPostcard size; defaults to '4x6'. Valid options: '4x6', '6x9'
4x66x9messagestringHandwritten message content
nostampbooleanIf true, omit the postal stamp from proof
to_citystringObligatorioRecipient city
to_namestringObligatorioRecipient's full name
to_statestringObligatorioRecipient state or province code (ISO)
qrcode_urlanyuriURL for autogenerated QR code on back of postcard
to_addressstringObligatorioRecipient street address
to_countrystringObligatorioRecipient country code (ISO-3166-1 alpha-2)
return_citystringReturn city
return_namestringReturn address name
to_address2stringRecipient address line 2
return_statestringReturn state or province code (ISO)
back_image_urlanyuriURL to image for back of postcard
return_addressstringReturn street address
to_postal_codestringObligatorioRecipient postal code
front_image_urlanyuriURL to image for front of postcard
return_address2stringReturn address line 2
handwriting_colorstringHandwriting ink color (e.g., 'blue', 'black', '#4287f5')
handwriting_styleintegerID of handwriting style to use
return_postal_codestringReturn postal code
back_image_html_urlanyuriURL to HTML file for back image generation
front_image_html_urlanyuriURL to HTML file for front image generation
back_image_html_contentstringRaw HTML content to render back image
custom_background_imageanyuriURL to custom background image
front_image_html_contentstringRaw HTML content to render front image
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Multiple RecipientsTHANKS_IO_RECIPIENTS_CREATE_MULTIAcciónTool to create multiple recipients at once in a mailing list. use when batching recipient additions for efficiency.
THANKS_IO_RECIPIENTS_CREATE_MULTIAcciónTool to create multiple recipients at once in a mailing list. use when batching recipient additions for efficiency.
Parámetros de entrada
list_idstringObligatorioID of the mailing list to which recipients will be added
recipientsobject[]ObligatorioList of recipients to create at once in the mailing list
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Recipient by AddressTHANKS_IO_RECIPIENTS_DELETE_BY_ADDRESSAcciónTool to delete a recipient by address and postal code. use when you need to remove a recipient without their id.
THANKS_IO_RECIPIENTS_DELETE_BY_ADDRESSAcciónTool to delete a recipient by address and postal code. use when you need to remove a recipient without their id.
Parámetros de entrada
addressstringObligatorioFull street address of the recipient
postal_codestringObligatorioPostal or ZIP code of the recipient's address
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Recipient DetailsTHANKS_IO_RECIPIENTS_GET_DETAILSAcciónTool to get details for a specific recipient by id. use to verify a recipient’s full address and custom fields.
THANKS_IO_RECIPIENTS_GET_DETAILSAcciónTool to get details for a specific recipient by id. use to verify a recipient’s full address and custom fields.
Parámetros de entrada
recipient_idstringObligatorioUnique identifier of the recipient to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search Recipients by EmailTHANKS_IO_RECIPIENTS_SEARCH_BY_EMAILAcciónTool 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]."
THANKS_IO_RECIPIENTS_SEARCH_BY_EMAILAcciónTool 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]."
Parámetros de entrada
emailstringObligatorioEmail address to search for.
limitintegerMaximum number of recipients to return; defaults to server limit if unset.
mailing_list_idsinteger[]ObligatorioArray of mailing list IDs to search in.
Parámetros de salida
tointegerObligatorioIndex of last recipient on this page.
dataobject[]ObligatorioList of matching recipients on this page.
fromintegerObligatorioIndex of first recipient on this page.
pathstringObligatorioBase API path for this endpoint.
errorstringError if any occurred during the execution of the action
totalintegerObligatorioTotal matching recipients across all pages.
per_pageintegerObligatorioResults per page as returned by server.
last_pageintegerObligatorioTotal number of pages available.
successfulbooleanObligatorioWhether or not the action execution was successful or not
current_pageintegerObligatorioCurrent page of results.
last_page_urlstringObligatorioURL of the last page of results.
next_page_urlstringURL of the next page, if any.
prev_page_urlstringURL of the previous page, if any.
first_page_urlstringObligatorioURL of the first page of results.
Update RecipientTHANKS_IO_RECIPIENTS_UPDATEAcciónTool to update existing recipient details by recipient id. use when modifying recipient data after confirming the recipient exists.
THANKS_IO_RECIPIENTS_UPDATEAcciónTool to update existing recipient details by recipient id. use when modifying recipient data after confirming the recipient exists.
Parámetros de entrada
citystringCity of the recipient's address
namestringFull name of the recipient
emailanyemailEmail address of the recipient
phonestringPhone number of the recipient
addressstringPrimary street address of the recipient
countrystringCountry code of the recipient's address (ISO 3166-1 alpha-2)
custom1stringCustom field 1 for the recipient
custom2stringCustom field 2 for the recipient
custom3stringCustom field 3 for the recipient
custom4stringCustom field 4 for the recipient
address2stringAdditional address information (e.g., apartment or suite number)
provincestringState or province of the recipient's address
postal_codestringPostal or ZIP code of the recipient's address
recipient_idstringObligatorioUnique identifier of the recipient to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send PostcardTHANKS_IO_SEND_POSTCARDAcciónTool to send a customized postcard. use when you need to dispatch a physical postcard with a chosen image and handwritten message.
THANKS_IO_SEND_POSTCARDAcciónTool to send a customized postcard. use when you need to dispatch a physical postcard with a chosen image and handwritten message.
Parámetros de entrada
sizestringenumPostcard size; defaults to '4x6'
4x66x96x11messagestringHandwritten message content (required if 'message_template' is not provided)
qrcode_urlanyuriURL to auto-generate a QR code on the back of the postcard
recipientsobject[]Explicit recipient objects
sub_accountstringID of the sub-account to bill this order
mailing_listsstring[]List of mailing-list IDs to send to
radius_searchobjectParameters for a radius-based address search.
image_templatestringID of a pre-saved front-image template (required if 'front_image_url' is not provided)
return_addressobjectOptional return address fields for the postcard.
front_image_urlanyuriURL to the image for the front of the postcard (required if 'image_template' is not provided)
email_additionalanyemailEmail address to receive order alerts (e.g., QR scan notifications)
message_templatestringID of a pre-saved message template (required if 'message' is not provided)
handwriting_colorstringHandwriting ink color (e.g., 'blue', 'black', '#4287f5')
handwriting_stylestringID of the handwriting style to use
send_standard_mailbooleanIf true, sends as USPS Standard Mail postage class
use_custom_backgroundbooleanWhether to use a custom background image
custom_background_imageanyuriURL to a custom background image (1875×1275 px)
Parámetros de salida
dataobjectPreview data returned when 'preview' True.
errorstringError if any occurred during the execution of the action
statusstringStatus of the request (e.g., '200')
messagestringResult message (e.g., 'Order being processed')
successfulbooleanObligatorioWhether or not the action execution was successful or not
Stored Send NotecardTHANKS_IO_STORED_SEND_NOTECARDAcciónTool 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.
THANKS_IO_STORED_SEND_NOTECARDAcciónTool 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.
Parámetros de entrada
messagestringObligatorioHandwritten message content for the notecard
qrcode_urlanyuriURL to generate a QR code inside the notecard
recipientsobject[]ObligatorioList of recipient mailing details
sub_accountstringID of the sub-account to use for this order
front_image_urlanyObligatoriouriURL to the image for the front of the notecard
email_additionalanyemailEmail to send order alerts (e.g., QR scan notifications)
handwriting_coloranyHandwriting color name or hex code
handwriting_stylestringID of the handwriting style to use
send_standard_mailbooleanSet to true to send via standard mail postage
use_custom_backgroundbooleanWhether to use a custom background image
custom_background_imageanyuriURL to custom background (1650×2475px required)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Stored Send PostcardTHANKS_IO_STORED_SEND_POSTCARDAcciónTool 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.
THANKS_IO_STORED_SEND_POSTCARDAcciónTool 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.
Parámetros de entrada
sizestringenumPostcard size
4x66x96x11messagestringHandwritten message content
previewbooleanIf true, return preview images instead of scheduling send
qrcode_urlstringURL to auto-generate a QR code on back
recipientsobject[]List of recipients
mailing_listsstring[]List of mailing list IDs
image_templatestringID of front-image template
front_image_urlstringURL to front image
message_templatestringID of message template
handwriting_colorstringHandwriting ink color
handwriting_stylestringID of handwriting style to apply
custom_background_imagestringURL to custom background image
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Stored Send Windowless LetterTHANKS_IO_STORED_SEND_WINDOWLESS_LETTERAcciónTool to create a stored send for a windowless letter. use when you need to prepare a letter order for later execution.
THANKS_IO_STORED_SEND_WINDOWLESS_LETTERAcciónTool to create a stored send for a windowless letter. use when you need to prepare a letter order for later execution.
Parámetros de entrada
messagestringObligatorioHandwritten message content
recipientsobject[]ObligatorioList of recipients to schedule the stored send for
front_image_urlanyObligatoriouriURL to the cover image for the windowless letter
handwriting_styleintegerObligatorioID of the handwriting style to use
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Sub-AccountTHANKS_IO_SUB_ACCOUNTS_CREATEAcciónTool to create a new sub-account. use when you need to manage separate profiles with distinct return addresses and settings.
THANKS_IO_SUB_ACCOUNTS_CREATEAcciónTool to create a new sub-account. use when you need to manage separate profiles with distinct return addresses and settings.
Parámetros de entrada
titlestringObligatorioName of the sub-account
return_citystringObligatorioCity for the return address
return_namestringObligatorioName for the return address
return_statestringObligatorioState for the return address (2-letter code)
return_addressstringObligatorioPrimary return street address
return_address2stringSecondary return street address (optional)
return_postal_codestringObligatorioPostal code for the return address
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Sub AccountsTHANKS_IO_SUB_ACCOUNTS_LISTAcciónTool to list all available sub-accounts. use when you need to select a sub-account for operations requiring a sub-account context.
THANKS_IO_SUB_ACCOUNTS_LISTAcciónTool to list all available sub-accounts. use when you need to select a sub-account for operations requiring a sub-account context.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sub Account DetailsTHANKS_IO_SUB_ACCOUNTS_SHOWAcciónTool 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.
THANKS_IO_SUB_ACCOUNTS_SHOWAcciónTool 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.
Parámetros de entrada
sub_account_idstringObligatorioUnique identifier of the sub-account to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Sub-AccountTHANKS_IO_SUB_ACCOUNTS_UPDATEAcciónTool 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.
THANKS_IO_SUB_ACCOUNTS_UPDATEAcciónTool 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.
Parámetros de entrada
titlestringNew name for the sub-account.
return_citystringNew city for the return address.
return_namestringNew return recipient name.
return_statestringNew state/province for the return address (2-letter code).
return_addressstringNew primary return street address.
sub_account_idstringObligatorioUnique identifier of the sub-account to update.
return_address2stringNew secondary return address (optional).
return_postal_codestringNew postal code for the return address.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not