Quickstart

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

In your dashboard, open Settings → API Access and click Create API Key in the API Keys section.

Enable Testing Mode

On the same page, turn on Test Mode in the API Settings section 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"
  }'

For a production integration, we recommend sending a creative instead: design and save it once in your dashboard, then send it with a single creative_id in place of the image and message parameters. See Send a Creative.

Check Your Order Status

Check the result on the Orders page (Orders in the dashboard sidebar). While testing mode is enabled, your order should appear and then be canceled automatically.

Next Steps

Design a creative in your dashboard and send it by ID — the recommended path for production sends. See Send a Creative and List Creatives.

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