Quickstart

Use this quickstart if you want to send mailers directly from your application. If you want your users to manage campaigns and automation inside thanks.io, start with the campaign workflow instead.

Before You Start

You will need:

A thanks.io account
An API key from API Settings
API Testing Mode enabled while you validate your integration

Choose the Right Path

There are two common ways to integrate with thanks.io:

Automation workflow: add recipients to a mailing list and let thanks.io handle campaign logic. This is usually the best fit for recurring sends and user-managed campaigns.
Direct API sends: create orders from your application and send mail immediately. This quickstart covers that path.

Once you know you want direct sends, follow the steps below to submit your first order.

Create Account

Create an account at thanks.io if you have not already.

Create An API Key

Visit API Settings and create a personal access token for your integration.

Enable Testing Mode

Turn on API/Zapier Test Mode to avoid sending real mail while testing. In testing mode, API orders are automatically canceled instead of mailed. See API Testing Mode for details.

Submit Your First Order

This example sends a postcard directly through the API using an inline recipient, message, and front image URL.

curl -X POST "https://api.thanks.io/api/v2/send/postcard" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "recipients": [{ 
      "name": "John Doe", 
      "address": "123 Main Street, Any Town, NY 12345"
    }],
    "message": "Hi %FIRST_NAME% - Thank you for your business!",
    "front_image_url": "https://cdn.thanks.io/inspiration_templates/default10.png"
  }'

Check Your Order Status

Check the result in the Order History page. While testing mode is enabled, your order should appear and then be canceled automatically.

Next Steps

If you want to send mailpiece types other than postcards, review Direct Send Orders.
If you need authentication guidance, see Bearer Token and OAuth.
If you decide your users should manage campaigns in thanks.io, switch to the campaign workflow.

Get Started

Common Workflows

FAQs

Before You Start

Choose the Right Path

Next Steps

​Before You Start

​Choose the Right Path

​Next Steps

Before You Start

Choose the Right Path

Next Steps