# thanks.io Direct Mail Automation Toolkit - [Welcome](https://docs.thanks.io/index.md): Welcome to thanks.io - [Quickstart](https://docs.thanks.io/quickstart.md): Start sending awesome mailers in under 5 minutes - [thanks.io MCP Server](https://docs.thanks.io/thanks-io-mcp-server.md): Connect Claude, ChatGPT, Gemini, Cursor or any MCP client to your thanks.io account to plan, preview and send real postcards, letters, notecards, magnacards and gift cards. - [Documentation MCP Server](https://docs.thanks.io/mcp-server.md): Model Context Protocol (MCP) server that gives AI coding assistants search access to the thanks.io API documentation and endpoint reference. - [Product Updates](https://docs.thanks.io/updates.md): New Features, Updates and Announcements - [Add Recipient to Campaign](https://docs.thanks.io/workflows/campaign.md): Add a recipient to an existing campaign via API - [Postcard Order](https://docs.thanks.io/workflows/postcard-order.md): Postcard Orders can be placed directly via the API - [PDF Letter Order](https://docs.thanks.io/workflows/letter-pdf-order.md): Submit an order using just a PDF via API - [Giftcard Order](https://docs.thanks.io/workflows/giftcard-order.md): Giftcards can be sent to recipients via the API. - [Quick Implementation](https://docs.thanks.io/faqs/quick-implementation.md): What's the easiest way to integrate with thanks.io? - [Front Images](https://docs.thanks.io/faqs/images.md): How do I set the front image for an Order? - [Message Content](https://docs.thanks.io/faqs/messages.md): How do I set the message content for an Order? - [Order Preview](https://docs.thanks.io/faqs/previews.md): How do I preview an order? - [QR Codes](https://docs.thanks.io/faqs/qrcode.md): How do I set the trackable QR code for an Order? - [Return Address](https://docs.thanks.io/faqs/return-address.md): How is return address set for an order? - [Design Gallery Overview](https://docs.thanks.io/design-gallery/introduction.md): Canva starter templates and ready-made design ideas for every thanks.io mailer type - [4x6 Postcards](https://docs.thanks.io/design-gallery/templates/4x6postcards.md): Starting templates to help you design your mailers - [6x9 Postcards](https://docs.thanks.io/design-gallery/templates/6x9postcards.md): Starting templates to help you design your mailers - [6x11 Postcards](https://docs.thanks.io/design-gallery/templates/6x11postcards.md): Starting templates to help you design your mailers - [Magnacards](https://docs.thanks.io/design-gallery/templates/magnacards.md): Starting templates to help you design your mailers - [Notecards](https://docs.thanks.io/design-gallery/templates/notecards.md): Starting templates to help you design your mailers - [Windowed Letters](https://docs.thanks.io/design-gallery/templates/windowed-letters.md): Starting templates to help you design your mailers - [Windowless Letters](https://docs.thanks.io/design-gallery/templates/windowless-letters.md): Starting templates to help you design your mailers - [Overview](https://docs.thanks.io/design-gallery/inspirations/postcards.md): Ready-made postcard design ideas, organized by holiday, life event, and industry - [4th of July Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-4thofjuly.md): Fourth of July and Independence Day-themed postcard inspirations and templates - [Anniversary Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-anniversary.md): Anniversary-themed postcard inspirations and templates - [April Fools Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-aprilfools.md): April Fools-themed postcard inspirations and templates - [Birthday Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-birthday.md): Birthday-themed postcard inspirations and templates - [Campaigns Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-campaigns.md): Campaigns-themed postcard inspirations and templates - [Car Dealership Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-cardealership.md): Car Dealership-themed postcard inspirations and templates - [Chiropractor Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-chiropractor.md): Chiropractor-themed postcard inspirations and templates - [Christmas Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-christmas.md): Christmas-themed postcard inspirations and templates - [Church Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-church.md): Church-themed postcard inspirations and templates - [Contractors Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-contractors.md): Contractors-themed postcard inspirations and templates - [Dentist Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-dentist.md): Dentist-themed postcard inspirations and templates - [Earth Day Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-earthday.md): Earth Day-themed postcard inspirations and templates - [Easter Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-easter.md): Easter-themed postcard inspirations and templates - [E-commerce Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-ecommerce.md): E-commerce-themed postcard inspirations and templates - [Father's Day Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-fathersday.md): Fathers day-themed postcard inspirations and templates - [Funny Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-funny.md): Funny-themed postcard inspirations and templates - [Halloween Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-halloween.md): Halloween-themed postcard inspirations and templates - [Hanukkah Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-hanukkah.md): Hanukkah-themed postcard inspirations and templates - [Holiday Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-holiday.md): Holiday-themed postcard inspirations and templates - [HouseAnniversary Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-houseaversary.md): Anniversary-themed postcard inspirations and templates - [Labor Day Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-laborday.md): Labor Day-themed postcard inspirations and templates - [Lawyer Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-lawyer.md): Lawyer-themed postcard inspirations and templates - [Memorial day Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-memorialday.md): Memorial day-themed postcard inspirations and templates - [Mother's Day Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-motherday.md): Mother's Day-themed postcard inspirations and templates - [New Year Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-newyear.md): New year-themed postcard inspirations and templates - [Politics Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-politics.md): Politics-themed postcard inspirations and templates - [Real Estate Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-realestate.md): Real Estate-themed postcard inspirations and templates - [St. Patrick's Day Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-stpatricks.md): St. Patrick's Day-themed postcard inspirations and templates - [Thanksgiving Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-thanksgiving.md): Thanksgiving-themed postcard inspirations and templates - [Thank You Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-thankyou.md): Thank You-themed postcard inspirations and templates - [Valentine's Day Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-valentinesday.md): Valentine's Day-themed postcard inspirations and templates - [Veterans Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-veterans.md): Veterans-themed postcard inspirations and templates - [Veterinarian Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-veterinarian.md): Veterinarian-themed postcard inspirations and templates - [Window Cleaning Postcards](https://docs.thanks.io/design-gallery/inspirations/postcards-windowcleaning.md): Window Cleaning-themed postcard inspirations and templates - [Overview](https://docs.thanks.io/design-gallery/inspirations/notecards.md): Ready-made notecard and gift card design ideas to use as the front of a thanks.io creative - [Birthday Notecards](https://docs.thanks.io/design-gallery/inspirations/notecards-birthday.md): Birthday-themed notecard inspirations and templates - [Co-Worker Notecards](https://docs.thanks.io/design-gallery/inspirations/notecards-work.md): Co-Worker greeting card inspirations and templates - [REST API Overview](https://docs.thanks.io/api-reference/introduction.md): Learn about thanks.io's REST API capabilities - [API Testing Mode](https://docs.thanks.io/api-reference/api-mode.md): Cancel API orders automatically while you build, and understand the 5-record Radius Search limit that applies while it is on. - [API Log](https://docs.thanks.io/api-reference/audit-log.md): Find the API and Zapier sends made on your account in the dashboard's Audit Log. - [Rate Limits](https://docs.thanks.io/api-reference/rate-limits.md): Understand the rate limits for the thanks.io API. - [OpenAPI Specification](https://docs.thanks.io/api-reference/openapi-link.md): The complete OpenAPI specification for the thanks.io API can be found [here](https://raw.githubusercontent.com/thanks-io/thanks.io-api-docs/refs/heads/main/api-reference/openapi.json). - [Choosing an Authentication Method](https://docs.thanks.io/authentication/choosing-auth-method.md): Decide whether your integration should use a bearer token or OAuth - [Bearer Token](https://docs.thanks.io/authentication/bearer-token.md): API Authentication - [OAuth](https://docs.thanks.io/authentication/oauth.md): OAuth Authentication integrating thanks.io with your application - [Usage](https://docs.thanks.io/api-reference/recipients-usage.md): Info on using thanks.io's Recipients endpoints - [Create Recipient](https://docs.thanks.io/api-reference/endpoint/recipients/create-recipient.md): Add a recipient. If you do not provide a valid mailing address but do provide a valid email address, thanks.io can attempt to look up a street address for an additional fee. - [Recipient Details](https://docs.thanks.io/api-reference/endpoint/recipients/get-details.md): Get a recipient by ID. - [Update Recipient](https://docs.thanks.io/api-reference/endpoint/recipients/update-recipient.md): Update details of a specific recipient by ID. Leave out `absentee_address` to keep the current absentee address. Sending it replaces the stored absentee address as a whole, so send it together with any of `absentee_city`, `absentee_province` and `absentee_postal_code`: those on their own, for exampl… - [Delete Recipient](https://docs.thanks.io/api-reference/endpoint/recipients/delete-recipient.md) - [Create Multiple Recipients](https://docs.thanks.io/api-reference/endpoint/recipients/create-multiple-recipients.md): Add multiple recipients at once using a JSON array of recipient objects. If a recipient does not include a valid mailing address but does include a valid email address, thanks.io can attempt to look up a street address for an additional fee. - [Delete Recipient By Address](https://docs.thanks.io/api-reference/endpoint/recipients/delete-recipient-by-address.md): Delete a recipient by using their address or their email address. - [Usage](https://docs.thanks.io/api-reference/mailing-lists-usage.md): Info on using thanks.io's Mailing Lists endpoints - [List All](https://docs.thanks.io/api-reference/endpoint/mailing-lists/list-all.md): List all available mailing lists. Returns a paginated list of mailing lists. - [Create Mailing List](https://docs.thanks.io/api-reference/endpoint/mailing-lists/create-mailing-list.md): If qrcode_url is provided, it will be used as the default QR Code URL when placing orders with this mailing list. - [Get Details](https://docs.thanks.io/api-reference/endpoint/mailing-lists/get-details.md): Gets a mailing list by ID. Returns a single mailing list object. - [Delete Mailing List](https://docs.thanks.io/api-reference/endpoint/mailing-lists/delete-mailing-list.md) - [List Recipients](https://docs.thanks.io/api-reference/endpoint/mailing-lists/list-recipients.md): Retrieve recipients for a specific mailing list. - [Radius Search Count](https://docs.thanks.io/api-reference/endpoint/mailing-lists/radius-search-count.md): This call reports how many records a radius search would find, without buying them. Nothing is charged, no mailing list is created, and the call can be repeated freely, so use it to preview a search before purchasing it with the Radius Search endpoint. It accepts the same search parameters with the… - [Radius Search](https://docs.thanks.io/api-reference/endpoint/mailing-lists/radius-search.md): This call will purchase a radius search mailing listing and add it to your account. Each record added to the mailing list costs $.05. You can specify the number of records to return (up to 2,500) and the address/postal code to center the search around. You can also specify a mailing_list_id to add t… - [Usage](https://docs.thanks.io/api-reference/send-mailer-usage.md): Info on using thanks.io's Send Mailer endpoints - [Send Postcard](https://docs.thanks.io/api-reference/endpoint/send-mailer/send-postcard.md): Send a 4x6, 6x9, or 6x11 postcard. - [Send Windowed Letter](https://docs.thanks.io/api-reference/endpoint/send-mailer/send-windowed-letter.md): Send a letter in a windowed envelope. - [Send Windowless Letter](https://docs.thanks.io/api-reference/endpoint/send-mailer/send-windowless-letter.md): Send a letter in a windowless envelope. - [Send Notecard](https://docs.thanks.io/api-reference/endpoint/send-mailer/send-notecard.md): Send a folded 4.25x5.5 notecard in envelope. - [Send Giftcard](https://docs.thanks.io/api-reference/endpoint/send-mailer/send-giftcard.md): Send a folded 4.25x5.5 giftcard in envelope. - [Send Magnacard](https://docs.thanks.io/api-reference/endpoint/send-mailer/send-magnacard.md): Send a Magnacard. - [Estimate Postcard](https://docs.thanks.io/api-reference/endpoint/estimate/estimate-postcard.md): Price a postcard order without placing it. Send the same request body you would send to Send Postcard: nothing is charged, nothing is printed or mailed, and no order is created. - [Estimate Windowed Letter](https://docs.thanks.io/api-reference/endpoint/estimate/estimate-windowed-letter.md): Price a windowed letter order without placing it. Send the same request body you would send to Send Windowed Letter: nothing is charged, nothing is printed or mailed, and no order is created. - [Estimate Windowless Letter](https://docs.thanks.io/api-reference/endpoint/estimate/estimate-windowless-letter.md): Price a windowless letter order without placing it. Send the same request body you would send to Send Windowless Letter: nothing is charged, nothing is printed or mailed, and no order is created. - [Estimate Notecard](https://docs.thanks.io/api-reference/endpoint/estimate/estimate-notecard.md): Price a notecard order without placing it. Send the same request body you would send to Send Notecard: nothing is charged, nothing is printed or mailed, and no order is created. - [Estimate Giftcard](https://docs.thanks.io/api-reference/endpoint/estimate/estimate-giftcard.md): Price a giftcard order without placing it. Send the same request body you would send to Send Giftcard: nothing is charged, nothing is printed or mailed, and no order is created. - [Estimate Magnacard](https://docs.thanks.io/api-reference/endpoint/estimate/estimate-magnacard.md): Price a magnacard order without placing it. Send the same request body you would send to Send Magnacard: nothing is charged, nothing is printed or mailed, and no order is created. - [Usage](https://docs.thanks.io/api-reference/creatives-library-usage.md): Info on using thanks.io's Creatives Library endpoints - [List Creatives](https://docs.thanks.io/api-reference/endpoint/creatives-library/list-all-creatives.md): List the creatives in your Creatives library, 24 per page: the default creative of each type first, then most recently updated. A creative pairs an image template with a message template; send one by passing its `id` as `creative_id` to any send or estimate endpoint. - [Get Creative](https://docs.thanks.io/api-reference/endpoint/creatives-library/get-creative.md): Get one creative from your Creatives library, with the image and message templates it pairs. - [Usage](https://docs.thanks.io/api-reference/message-templates-usage.md): Info on using thanks.io's Message Templates endpoints - [List Message Templates](https://docs.thanks.io/api-reference/endpoint/message-templates/list-all-message-templates.md): List all available message templates. - [Create Message Template](https://docs.thanks.io/api-reference/endpoint/message-templates/create-message-template.md): Create a message template for the authenticated user using the public v2 request shape. - [Get Message Template](https://docs.thanks.io/api-reference/endpoint/message-templates/get-message-template.md): Fetch a single message template by ID. - [Update Message Template](https://docs.thanks.io/api-reference/endpoint/message-templates/update-message-template.md): Update a message template using the public v2 request shape. - [Delete Message Template](https://docs.thanks.io/api-reference/endpoint/message-templates/delete-message-template.md): Delete a message template. - [Create Sub-Account](https://docs.thanks.io/api-reference/endpoint/sub-accounts/create-sub-account.md): Create a new sub-account. - [Show Sub-Account](https://docs.thanks.io/api-reference/endpoint/sub-accounts/get-details.md): Gets a sub-account by ID. Returns a single sub-account object. branding_fields is an object that contains branding information for the sub-account - it can only be set via the thanks.io dashboard - [Update Sub-Account](https://docs.thanks.io/api-reference/endpoint/sub-accounts/update-sub-account.md) - [Delete Sub-Account](https://docs.thanks.io/api-reference/endpoint/sub-accounts/delete-sub-account.md): Delete a sub-account. All sub-account orders and mailing lists are moved to the main account. All image templates, message templates, and campaigns are deleted. - [List Sub-Accounts](https://docs.thanks.io/api-reference/endpoint/sub-accounts/list-all.md): List all available sub-accounts. - [List Image Templates](https://docs.thanks.io/api-reference/endpoint/image-templates/list-all-image-templates.md): List all available image templates. - [List Orders](https://docs.thanks.io/api-reference/endpoint/orders/list-orders.md): Return list of recent orders. - [Track Order](https://docs.thanks.io/api-reference/endpoint/orders/track-order.md): Return Summary of delivery status for the order. - [List Order Items](https://docs.thanks.io/api-reference/endpoint/orders/list-order-items.md): Return the individual mail pieces that make up an order, one entry per recipient, with that piece's delivery status, delivery date, QR scan count, failure reason and recipient address. Use this when you need per-piece detail; Track Order returns the same order as aggregate counts instead. - [Cancel Order](https://docs.thanks.io/api-reference/endpoint/orders/cancel-order.md): If Order is in _Reviewing_ Status, then this will cancel the order and refund the credits for the order back to your account. If the order can be successfully canceled, the status will be updated to _cancelled_. - [Replay Order](https://docs.thanks.io/api-reference/endpoint/orders/replay-order.md): Submit a copy of a previously placed order as a brand-new order. The same creative is charged and mailed again, and the original order is left untouched. By default the replay is sent to the recipients the original actually reached (failed items are excluded). Supply a `recipients` array to send the… - [Invalidate Gift Card](https://docs.thanks.io/api-reference/endpoint/orders/invalidate-giftcard.md): Invalidate the gift card on a mailed piece so it can no longer be redeemed, for example when a card was sent by mistake. This does the same as the **Invalidate** button on the Order Details page, and it can't be undone. `PATCH` is accepted as well as `PUT`. - [List Webhooks](https://docs.thanks.io/api-reference/endpoint/webhooks/list-all.md): Return a paginated list of configured webhooks. Webhooks are available on paid subscriptions only. - [Create Webhook](https://docs.thanks.io/api-reference/endpoint/webhooks/create-webhook.md): Create a webhook destination. Webhooks are available on paid subscriptions only. - [Update Webhook](https://docs.thanks.io/api-reference/endpoint/webhooks/update-webhook.md): Update an existing webhook destination. Webhooks are available on paid subscriptions only. - [Delete Webhook](https://docs.thanks.io/api-reference/endpoint/webhooks/delete-webhook.md): Delete a webhook destination. Webhooks are available on paid subscriptions only. - [Order Item Status Change](https://docs.thanks.io/api-reference/endpoint/webhook-events/order-item-status-change.md): Webhook payload for order item status updates - [Order Status Change](https://docs.thanks.io/api-reference/endpoint/webhook-events/order-status-change.md): Webhook payload for order status updates - [Order Item Delivered](https://docs.thanks.io/api-reference/endpoint/webhook-events/order-item-delivered.md): Webhook payload for delivered order items - [QR Code Scans](https://docs.thanks.io/api-reference/endpoint/webhook-events/qr-code-scans.md): Webhook payload for QR code scan events - [Scan Board Stage Change](https://docs.thanks.io/api-reference/endpoint/webhook-events/scan-board-stage-change.md): Webhook payload for QR Scan Board stage changes - [List Handwriting Styles](https://docs.thanks.io/api-reference/endpoint/handwriting-styles/list-styles.md): List Available Handwriting Styles - [List Gift Card Brands Flat](https://docs.thanks.io/api-reference/endpoint/giftcards/list-brands-flat.md): List all available Giftcard brands as a flat list. - [List Gift Card Brands](https://docs.thanks.io/api-reference/endpoint/giftcards/list-brands.md): List all available Giftcard brands. - [Add Recipient to Campaign](https://docs.thanks.io/workflows/campaign.md): Add a recipient to an existing campaign via API - [PDF Letter Order](https://docs.thanks.io/workflows/letter-pdf-order.md): Submit an order using just a PDF via API - [Postcard Order](https://docs.thanks.io/workflows/postcard-order.md): Postcard Orders can be placed directly via the API - [Giftcard Order](https://docs.thanks.io/workflows/giftcard-order.md): Giftcards can be sent to recipients via the API. - [Native Integrations](https://docs.thanks.io/native-integrations/introduction.md): Native Integrations to easily connect thanks.io with your favorite tools - [Zapier](https://docs.thanks.io/native-integrations/available/zapier.md): thanks.io / Zapier Integration - [make](https://docs.thanks.io/native-integrations/available/make.md): thanks.io / make Integration - [Zoho](https://docs.thanks.io/native-integrations/available/zoho.md): thanks.io / Zoho Integration - [n8n Integration](https://docs.thanks.io/native-integrations/available/n8n.md): Automate thanks.io directly from your n8n workflows - [HubSpot](https://docs.thanks.io/native-integrations/available/hubspot.md): thanks.io / HubSpot Integration - [Integrately](https://docs.thanks.io/native-integrations/available/integrately.md): thanks.io / Integrately Integration - [Pabbly](https://docs.thanks.io/native-integrations/available/pabbly.md): thanks.io / Pabbly Integration - [viaSocket](https://docs.thanks.io/native-integrations/available/viasocket.md): thanks.io / viaSocket Integration - [Sure Send](https://docs.thanks.io/native-integrations/available/sure-send.md): thanks.io / Sure Send Integration - [HighLevel](https://docs.thanks.io/native-integrations/available/highlevel.md): thanks.io / HighLevel Integration - [API Nation](https://docs.thanks.io/native-integrations/available/api-nation.md): thanks.io / API Nation Integration - [API Nation Webhooks](https://docs.thanks.io/native-integrations/available/api-nation-webhooks.md): thanks.io / API Nation Webhooks Integration - [Bold Trail/kvCORE](https://docs.thanks.io/native-integrations/available/boldtrail.md): thanks.io / Bold Trail Integration - [MedicarePRO](https://docs.thanks.io/native-integrations/available/medicarepro.md): thanks.io / MedicarePRO Integration - [Email](https://docs.thanks.io/native-integrations/available/email.md): thanks.io Email Integration - [Embed Widget](https://docs.thanks.io/native-integrations/available/embed-widget.md): thanks.io Embed Widget Integration - [Webhooks](https://docs.thanks.io/webhooks/introduction.md): Real time event notifications with thanks.io webhooks - [Order Item Status Change](https://docs.thanks.io/webhooks/available/order-item-status-change.md): Event will fire whenever an Recipient's Order Item (Mail Piece) changes status. An order item represents the details of an individual mail piece sent to a recipient. - [Order Item Delivered](https://docs.thanks.io/webhooks/available/order-item-delivered.md): Event will fire whenever an Recipient's Order Item (Mail Piece) is delivered - [Order Status Change](https://docs.thanks.io/webhooks/available/order-status-change.md): Event will fire whenever an Order changes status. - [QR Code Scans](https://docs.thanks.io/webhooks/available/qr-code-scans.md): Event will fire whenever a recipient scans a thanks.io QR Code on your mailer. - [Scan Board Stage Change](https://docs.thanks.io/webhooks/available/scan-board-stage-change.md): Event will fire whenever a card on your QR Scan Board enters the stage the webhook is set to. ## OpenAPI Specs - [openapi](/api-reference/openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.