Skip to main content

​
Welcome

The thanks.io API enables developers to integrate direct mail capabilities into their applications. With the API, you can either send mailpieces directly from your application or add recipients to an existing thanks.io automation workflow.

​
Start Here

If you are new to the platform, use this sequence:
  1. Choose how you want to authenticate in Choosing an Authentication Method.
  2. If you want to send orders directly from your app, follow the Quickstart.
  3. If you want thanks.io to handle automation logic, start with the campaign workflow.

​
Core Concepts

These concepts will make the generated endpoint pages much easier to understand:
  • Recipients: the people or addresses you want to mail.
  • Mailing lists: saved recipient groups managed inside thanks.io.
  • Direct send orders: one-off API-created mailers such as postcards, letters, notecards, gift cards, and magnacards.
  • Automation workflows: rules or campaigns that run inside thanks.io after you add recipients or trigger events.
  • Creatives: saved pairings of an image template and a message template in your Creatives library. Sending one by creative_id is the recommended way to send — see Creatives Library.
  • Templates: reusable image and message assets that can be referenced instead of inlining content on every request.

​
OpenAPI Specification

The complete OpenAPI specification for the thanks.io API can be found here. Use the generated endpoint pages in this documentation when you want interactive reference docs. Use the raw OpenAPI file when you want to generate an SDK or inspect the entire schema at once.

​
Postman Collection

To try the API in Postman, fork the thanks.io Postman collection. It is generated from the same OpenAPI specification, with example requests and responses for every endpoint. Set its api_key variable to your API key, and turn on API Testing Mode while you experiment so orders are cancelled automatically.