NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Thanks.io

thanks_io

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

Marketing AutomationWeb del proveedor
Acciones
33
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

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

Parámetros de entrada

  • citystringObligatorio

    City of the recipient's address

  • namestringObligatorio

    Full name of the recipient

  • emailanyemail

    Recipient's email address

  • phonestring

    Recipient's phone number

  • addressstringObligatorio

    Primary street address of the recipient

  • countrystringObligatorio

    Country code of the recipient's address (ISO 3166-1 alpha-2)

  • address2string

    Additional address information (e.g., apartment or suite number)

  • provincestringObligatorio

    State or province of the recipient's address

  • postal_codestringObligatorio

    Postal or ZIP code of the recipient's address

  • mailing_liststringObligatorio

    ID of the mailing list to which the recipient will be added

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Mailing ListTHANKS_IO_CREATE_MAILING_LISTAcción

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

Parámetros de entrada

  • namestringObligatorio

    Name of the new mailing list

  • descriptionstring

    Brief description of the mailing list

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Mailing ListTHANKS_IO_DELETE_MAILING_LISTAcción

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

Parámetros de entrada

  • list_idstringObligatorio

    The UUID of the mailing list to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Recipient from Mailing ListTHANKS_IO_DELETE_RECIPIENT_FROM_MAILING_LISTAcción

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

Parámetros de entrada

  • recipient_idstringObligatorio

    Unique identifier of the recipient to remove

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Sub-AccountTHANKS_IO_DELETE_SUB_ACCOUNTAcción

Tool 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

  • idintegerObligatorio

    The unique ID of the sub-account to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Execute Stored SendTHANKS_IO_EXECUTE_STORED_SENDAcción

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.

Parámetros de entrada

  • uuidanyObligatoriouuid

    UUID of the stored send resource to execute

  • send_typestringObligatorioenum

    Type of stored send to execute

    postcardletterwindowlessletternotecardgiftcard

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Handwriting StylesTHANKS_IO_LIST_HANDWRITING_STYLESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Image TemplatesTHANKS_IO_LIST_IMAGE_TEMPLATESAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Mailing ListsTHANKS_IO_LIST_MAILING_LISTSAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Message TemplatesTHANKS_IO_LIST_MESSAGE_TEMPLATESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Buy Radius Search Mailing ListTHANKS_IO_MAILING_LISTS_BUY_RADIUS_SEARCHAcción

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.

Parámetros de entrada

  • addressstringObligatorio

    Full address to use as the center of the radius search

  • previewboolean

    Return a preview of the number of neighbors found and cost

  • append_databoolean

    Append phone and email to each record for an additional fee

  • postal_codestringObligatorio

    Postal code for the search

  • record_countintegerObligatorio

    Number of nearest neighbors to search for (1-10000)

  • record_typesstringenum

    Type of records to search for

    alllikelytomovelikelytorefiabsenteeownerhighnetworthmajorityhomeequityhomefreeclearunderwaterkidsinhouseholdnewhomeownerfirsttimehomebuyerrenters+5
  • include_condosboolean

    Include condos in search results

  • use_property_ownerboolean

    Use property owner's address when searching for commercial record types

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Preview letter sendTHANKS_IO_ORDER_PREVIEW_LETTERAcción

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.

Parámetros de entrada

  • messagestring

    Handwritten message content to appear on the letter cover page.

  • previewbooleanObligatorio

    Must be true to generate and return PDF preview URLs instead of placing an order.

  • return_citystring

    City for the return address.

  • return_namestring

    Name to print on the return address block.

  • return_statestring

    State or province for the return address.

  • mailing_listsinteger[]

    IDs of mailing lists to preview. Required if recipients not provided.

  • return_addressstring

    Street address line 1 for the return address.

  • front_image_urlstringObligatoriouri

    URL to the cover image for the front of the letter (JPEG/PNG).

  • return_address2string

    Street address line 2 for the return address.

  • handwriting_styleinteger

    ID of the handwriting style to use for the letter body.

  • return_postal_codestring

    Postal or ZIP code for the return address.

  • additional_pages_urlstringuri

    URL to a PDF file containing additional pages to include in the letter. Up to 10 pages allowed, printed double-sided.

Parámetros de salida

  • codeintegerObligatorio

    HTTP status code of the preview call.

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Status message from the API.

  • successbooleanObligatorio

    Whether the preview request succeeded.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Preview NotecardTHANKS_IO_ORDER_PREVIEW_NOTECARDAcción

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

Parámetros de entrada

  • messagestringObligatorio

    Handwritten message content to place inside the notecard.

  • previewbooleanObligatorio

    Must be true to return preview images instead of sending.

  • recipientsobject[]Obligatorio

    List of recipient objects for the notecard preview.

  • image_templateintegerObligatorio

    ID of a pre-saved notecard image template.

  • handwriting_styleintegerObligatorio

    ID of the handwriting style to use.

Parámetros de salida

  • codeintegerObligatorio

    HTTP status code returned by the API.

  • dataobjectObligatorio

    Container for preview image URLs.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Result message from the API.

  • successbooleanObligatorio

    Indicates whether the preview request succeeded.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Preview PostcardTHANKS_IO_ORDER_PREVIEW_POSTCARDAcción

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

Parámetros de entrada

  • sizestringenum

    Postcard size; defaults to '4x6'. Only valid for postcards.

    4x66x96x11
  • messagestring

    Handwritten message content. Required if 'message_template' not provided.

  • previewbooleanObligatorio

    Must be true to return preview images.

  • qrcode_urlanyuri

    URL 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_templatestring

    ID of a pre-saved front-image template. Required if 'front_image_url' not provided.

  • front_image_urlanyuri

    URL to the image for the front of the postcard. Required if 'image_template' not provided.

  • message_templatestring

    ID of pre-saved message template. Required if 'message' not provided.

  • handwriting_colorstring

    Handwriting ink color (e.g. 'blue', 'black', '#4287f5').

  • handwriting_stylestring

    ID of the handwriting style to use.

Parámetros de salida

  • codeintegerObligatorio

    HTTP status code returned.

  • dataobjectObligatorio

    Preview data containing images.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Result message.

  • successbooleanObligatorio

    Indicates request success.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Preview Windowless LetterTHANKS_IO_ORDER_PREVIEW_WINDOWLESS_LETTERAcción

Tool 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

  • messagestring

    Handwritten message content. Required if 'message_template' not set

  • previewbooleanObligatorio

    Must be true to return a PDF preview of the letter send

  • recipientsobject[]Obligatorio

    List of recipients for the preview send

  • front_image_urlanyObligatoriouri

    URL to the cover image for the windowless letter

  • message_templatestring

    ID of a stored message template. Required if 'message' not set

  • handwriting_colorstring

    Ink color for handwriting (e.g., 'blue','black', or hex code)

  • handwriting_stylestring

    ID of handwriting style to use

  • additional_pages_urlanyuri

    URL to a single-page PDF to print on back of cover image

Parámetros de salida

  • codeintegerObligatorio

    HTTP status code returned by the API

  • dataobjectObligatorio

    Preview data containing PDF URLs

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Result message from the API

  • successbooleanObligatorio

    Indicates if the preview request succeeded

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List OrdersTHANKS_IO_ORDERS_LISTAcción

Tool 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

  • limitinteger

    Maximum number of orders to return (1-100).

  • sub_account_idinteger

    Filter orders by this sub-account ID.

Parámetros de salida

  • dataobject[]Obligatorio

    List of order summaries.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • linksobjectObligatorio

    Pagination link URLs.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search Orders by Recipient Street AddressTHANKS_IO_ORDERS_SEARCH_BY_ADDRESSAcción

Tool 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

  • pageinteger

    Page number for paginated results, default is 1.

  • addressstringObligatorio

    Street address to search orders by.

  • per_pageinteger

    Number of results per page, between 1 and 100, default is 50.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search Orders by Recipient Full NameTHANKS_IO_ORDERS_SEARCH_BY_NAMEAcción

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

    Full name of the recipient to search orders by.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Order Summary StatisticsTHANKS_IO_ORDERS_STATSAcción

Tool 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

  • typestring

    Filter by order type (e.g., 'postcard', 'letter')

  • statusstring

    Filter by order status (e.g., 'pending', 'completed')

  • end_datestring

    End date for statistics (YYYY-MM-DD)

  • start_datestring

    Start date for statistics (YYYY-MM-DD)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Proof PostcardTHANKS_IO_PROOF_POSTCARDAcción

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.

Parámetros de entrada

  • sizestringenum

    Postcard size; defaults to '4x6'. Valid options: '4x6', '6x9'

    4x66x9
  • messagestring

    Handwritten message content

  • nostampboolean

    If true, omit the postal stamp from proof

  • to_citystringObligatorio

    Recipient city

  • to_namestringObligatorio

    Recipient's full name

  • to_statestringObligatorio

    Recipient state or province code (ISO)

  • qrcode_urlanyuri

    URL for autogenerated QR code on back of postcard

  • to_addressstringObligatorio

    Recipient street address

  • to_countrystringObligatorio

    Recipient country code (ISO-3166-1 alpha-2)

  • return_citystring

    Return city

  • return_namestring

    Return address name

  • to_address2string

    Recipient address line 2

  • return_statestring

    Return state or province code (ISO)

  • back_image_urlanyuri

    URL to image for back of postcard

  • return_addressstring

    Return street address

  • to_postal_codestringObligatorio

    Recipient postal code

  • front_image_urlanyuri

    URL to image for front of postcard

  • return_address2string

    Return address line 2

  • handwriting_colorstring

    Handwriting ink color (e.g., 'blue', 'black', '#4287f5')

  • handwriting_styleinteger

    ID of handwriting style to use

  • return_postal_codestring

    Return postal code

  • back_image_html_urlanyuri

    URL to HTML file for back image generation

  • front_image_html_urlanyuri

    URL to HTML file for front image generation

  • back_image_html_contentstring

    Raw HTML content to render back image

  • custom_background_imageanyuri

    URL to custom background image

  • front_image_html_contentstring

    Raw HTML content to render front image

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Multiple RecipientsTHANKS_IO_RECIPIENTS_CREATE_MULTIAcción

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

Parámetros de entrada

  • list_idstringObligatorio

    ID of the mailing list to which recipients will be added

  • recipientsobject[]Obligatorio

    List of recipients to create at once in the mailing list

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Recipient by AddressTHANKS_IO_RECIPIENTS_DELETE_BY_ADDRESSAcción

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

Parámetros de entrada

  • addressstringObligatorio

    Full street address of the recipient

  • postal_codestringObligatorio

    Postal or ZIP code of the recipient's address

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Recipient DetailsTHANKS_IO_RECIPIENTS_GET_DETAILSAcción

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

    Unique identifier of the recipient to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search Recipients by EmailTHANKS_IO_RECIPIENTS_SEARCH_BY_EMAILAcción

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

Parámetros de entrada

  • emailstringObligatorio

    Email address to search for.

  • limitinteger

    Maximum number of recipients to return; defaults to server limit if unset.

  • mailing_list_idsinteger[]Obligatorio

    Array of mailing list IDs to search in.

Parámetros de salida

  • tointegerObligatorio

    Index of last recipient on this page.

  • dataobject[]Obligatorio

    List of matching recipients on this page.

  • fromintegerObligatorio

    Index of first recipient on this page.

  • pathstringObligatorio

    Base API path for this endpoint.

  • errorstring

    Error if any occurred during the execution of the action

  • totalintegerObligatorio

    Total matching recipients across all pages.

  • per_pageintegerObligatorio

    Results per page as returned by server.

  • last_pageintegerObligatorio

    Total number of pages available.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • current_pageintegerObligatorio

    Current page of results.

  • last_page_urlstringObligatorio

    URL of the last page of results.

  • next_page_urlstring

    URL of the next page, if any.

  • prev_page_urlstring

    URL of the previous page, if any.

  • first_page_urlstringObligatorio

    URL of the first page of results.

Update RecipientTHANKS_IO_RECIPIENTS_UPDATEAcción

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

Parámetros de entrada

  • citystring

    City of the recipient's address

  • namestring

    Full name of the recipient

  • emailanyemail

    Email address of the recipient

  • phonestring

    Phone number of the recipient

  • addressstring

    Primary street address of the recipient

  • countrystring

    Country code of the recipient's address (ISO 3166-1 alpha-2)

  • custom1string

    Custom field 1 for the recipient

  • custom2string

    Custom field 2 for the recipient

  • custom3string

    Custom field 3 for the recipient

  • custom4string

    Custom field 4 for the recipient

  • address2string

    Additional address information (e.g., apartment or suite number)

  • provincestring

    State or province of the recipient's address

  • postal_codestring

    Postal or ZIP code of the recipient's address

  • recipient_idstringObligatorio

    Unique identifier of the recipient to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send PostcardTHANKS_IO_SEND_POSTCARDAcción

Tool 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

  • sizestringenum

    Postcard size; defaults to '4x6'

    4x66x96x11
  • messagestring

    Handwritten message content (required if 'message_template' is not provided)

  • qrcode_urlanyuri

    URL to auto-generate a QR code on the back of the postcard

  • recipientsobject[]

    Explicit recipient objects

  • sub_accountstring

    ID of the sub-account to bill this order

  • mailing_listsstring[]

    List of mailing-list IDs to send to

  • radius_searchobject

    Parameters for a radius-based address search.

  • image_templatestring

    ID of a pre-saved front-image template (required if 'front_image_url' is not provided)

  • return_addressobject

    Optional return address fields for the postcard.

  • front_image_urlanyuri

    URL to the image for the front of the postcard (required if 'image_template' is not provided)

  • email_additionalanyemail

    Email address to receive order alerts (e.g., QR scan notifications)

  • message_templatestring

    ID of a pre-saved message template (required if 'message' is not provided)

  • handwriting_colorstring

    Handwriting ink color (e.g., 'blue', 'black', '#4287f5')

  • handwriting_stylestring

    ID of the handwriting style to use

  • send_standard_mailboolean

    If true, sends as USPS Standard Mail postage class

  • use_custom_backgroundboolean

    Whether to use a custom background image

  • custom_background_imageanyuri

    URL to a custom background image (1875×1275 px)

Parámetros de salida

  • dataobject

    Preview data returned when 'preview' True.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstring

    Status of the request (e.g., '200')

  • messagestring

    Result message (e.g., 'Order being processed')

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Stored Send NotecardTHANKS_IO_STORED_SEND_NOTECARDAcción

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.

Parámetros de entrada

  • messagestringObligatorio

    Handwritten message content for the notecard

  • qrcode_urlanyuri

    URL to generate a QR code inside the notecard

  • recipientsobject[]Obligatorio

    List of recipient mailing details

  • sub_accountstring

    ID of the sub-account to use for this order

  • front_image_urlanyObligatoriouri

    URL to the image for the front of the notecard

  • email_additionalanyemail

    Email to send order alerts (e.g., QR scan notifications)

  • handwriting_colorany

    Handwriting color name or hex code

  • handwriting_stylestring

    ID of the handwriting style to use

  • send_standard_mailboolean

    Set to true to send via standard mail postage

  • use_custom_backgroundboolean

    Whether to use a custom background image

  • custom_background_imageanyuri

    URL to custom background (1650×2475px required)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Stored Send PostcardTHANKS_IO_STORED_SEND_POSTCARDAcción

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.

Parámetros de entrada

  • sizestringenum

    Postcard size

    4x66x96x11
  • messagestring

    Handwritten message content

  • previewboolean

    If true, return preview images instead of scheduling send

  • qrcode_urlstring

    URL to auto-generate a QR code on back

  • recipientsobject[]

    List of recipients

  • mailing_listsstring[]

    List of mailing list IDs

  • image_templatestring

    ID of front-image template

  • front_image_urlstring

    URL to front image

  • message_templatestring

    ID of message template

  • handwriting_colorstring

    Handwriting ink color

  • handwriting_stylestring

    ID of handwriting style to apply

  • custom_background_imagestring

    URL to custom background image

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Stored Send Windowless LetterTHANKS_IO_STORED_SEND_WINDOWLESS_LETTERAcción

Tool 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

  • messagestringObligatorio

    Handwritten message content

  • recipientsobject[]Obligatorio

    List of recipients to schedule the stored send for

  • front_image_urlanyObligatoriouri

    URL to the cover image for the windowless letter

  • handwriting_styleintegerObligatorio

    ID of the handwriting style to use

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Sub-AccountTHANKS_IO_SUB_ACCOUNTS_CREATEAcción

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

Parámetros de entrada

  • titlestringObligatorio

    Name of the sub-account

  • return_citystringObligatorio

    City for the return address

  • return_namestringObligatorio

    Name for the return address

  • return_statestringObligatorio

    State for the return address (2-letter code)

  • return_addressstringObligatorio

    Primary return street address

  • return_address2string

    Secondary return street address (optional)

  • return_postal_codestringObligatorio

    Postal code for the return address

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Sub AccountsTHANKS_IO_SUB_ACCOUNTS_LISTAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Sub Account DetailsTHANKS_IO_SUB_ACCOUNTS_SHOWAcción

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.

Parámetros de entrada

  • sub_account_idstringObligatorio

    Unique identifier of the sub-account to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Sub-AccountTHANKS_IO_SUB_ACCOUNTS_UPDATEAcción

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.

Parámetros de entrada

  • titlestring

    New name for the sub-account.

  • return_citystring

    New city for the return address.

  • return_namestring

    New return recipient name.

  • return_statestring

    New state/province for the return address (2-letter code).

  • return_addressstring

    New primary return street address.

  • sub_account_idstringObligatorio

    Unique identifier of the sub-account to update.

  • return_address2string

    New secondary return address (optional).

  • return_postal_codestring

    New postal code for the return address.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not