• Documentation >
• Apps >
• Marketing >
• Thanks.io

Thanks.io

The Thanks.io modules allow you to add, update, list. and delete the recipients and send postcards from your Thanks.io account.

Getting Started with Thanks.io

Prerequisites

• A Thanks.io account

In order to use Thanks.io with Ibexa Connect, it is necessary to have a Thanks.io account. If you do not have one, you can create a Thanks.io account at thanks.io.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Thanks.io to Ibexa Connect

To connect your Thanks.io account to Ibexa Connect you need to obtain the API Key from your Thanks.io account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your Thanks.io account.

2. Click Settings () > API Access.

3. In the Personal Access Token field, click + icon, enter a name for the token and click Create.

4. Copy the API Token to your clipboard.

   

5. Go to Ibexa Connect and open the Thanks.io module's Create a connection dialog.

   

6. In the Connection name field, enter a name for the connection.

7. In the API Key field, enter the token copied in step 4, and click Continue.

The connection has been established.

Send Letter/Postcard

Send a Letter

Sends a letter.

Front Image URL	Enter the letter's front image URL address.
Handwriting Style	Select or map the handwriting style for the letter.
Message	Enter the message text to add to the letter.
Mailing Lists	Add the mailing lists to which you want to send the letter.
Return Name	Enter the contact's name to return the letter if undelivered.
Return Address	Enter the street address to which the letter should be returned.
Return Address 2	Enter the street address to which the letter should be returned.
Return City	Enter the city name to which the letter should be returned.
Return State	Enter the state name to which the letter should be returned.
Return Postal Code	Enter the area postal code to which the letter should be returned.

Send a 4x6 Postcard

Sends a 4x6 postcard.

Image Template	Select or map the image template to use for the postcard.
Handwriting Style	Select or map the handwriting style to apply the postcard.
Message	Enter the message text to add to the postcard.
Recipients	Add the recipients of the postcard: Address Enter the recipient's street name. City Enter the recipient's city name. Province Enter the recipient's state or province name. Postal Code Enter the recipient's area postal code. Country Enter teh recipient's country name. Name Enter the recipient's name.
Use Custom Background	Select whether to apply the custom background to the postcard.
Custom Background Image URL	Enter the background image URL address to apply to the postcard.

Send a 6x9 Postcard

Sends a 6x9 postcard.

Image Template	Select or map the image template to use for the postcard.
Handwriting Style	Select or map the handwriting style to apply the postcard.
Message Template	Select or map the message template to apply to the postcard.
Address	Enter (map) the complete address to which you want to send the postcard. For example, 1 Main St, Warwick, NY 10990
Radius Distance Miles	Enter (map) the distance in miles.

Recipients

List Recipients

Lists all recipients in the selected mailing list.

Mailing List ID	Select or map the mailing list whose recipients you want to list.
Updated Since	Enter the date to list the recipient's updated on or after the specified date. See the list of supported date and time formats.
Limit	Set the maximum number of recipients Ibexa Connect should return during one execution cycle.

Get a Recipient

Returns details about the selected recipient.

Mailing List ID	Select or map the mailing list whose recipients you want to list.
Recipient ID	Select or map the Recipient ID whose details you want to retrieve.

Add a Recipient

Adds a recipient to a mailing list.

Mailing List ID	Select or map the mailing list to which you want to add the recipient.
Street Address	Enter the recipient's street name. For example, 7777 Main st.
Address 2	Enter the recipient's street name. For example, 7777 Main st.
Recipient Name	Enter the recipient's name.
City	Enter the recipient's city name.
Province	Enter the recipient's state or province name.
Postal Code	Enter the recipient's area postal code.
Country	Enter the recipient's country name.
Date of Birth	Enter the recipient's date of birth.
Custom 1	(Optional) Enter the custom field name and values for the recipient.
Custom 2	(Optional) Enter the custom field name and values for the recipient.

Update a Recipient

Updates an existing recipient from the selected mailing list.

Recipient ID	Select or map the Recipient ID whose details you want to update.
Mailing List ID	Select or map the mailing list to which you want to add the recipient.
Street Address	Enter the recipient's street name. For example, 7777 Main st.
Address 2	Enter the recipient's street name. For example, 7777 Main st.
Recipient Name	Enter the recipient's name.
City	Enter the recipient's city name.
Province	Enter the recipient's state or province name.
Postal Code	Enter the recipient's area postal code.
Country	Enter the recipient's country name.
Date of Birth	Enter the recipient's date of birth.
Custom 1	(Optional) Enter the custom field name and values for the recipient.
Custom 2	(Optional) Enter the custom field name and values for the recipient.

Delete a Recipient

Deletes an existing recipient from the selected mailing list.

Mailing List ID	Select or map the mailing list to which you want to add the recipient.
Recipient ID	Select or map the Recipient ID whose details you want to delete.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.thanks.io/api/. For example: /v2/ping

For the list of available endpoints, refer to the Thanks.io API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Get Mailing Lists

The following API call returns all the mailing lists from your Thanks.io account:

URL:

/v2/mailing-lists

Method:

GET

Matches of the search can be found in the module's Output under Bundle > Body > data.

In our example, 2 tasks were returned:

Get Order Details

Returns order details by ID.

Order ID	Select or map the Order ID whose details you want to retrieve.