Send Postcard

curl --request POST \
  --url https://api.thanks.io/api/v2/send/postcard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "size": "4x6",
  "front_image_url": "https://s3.amazonaws.com/cdn.thanks.io/user_image_library/gFBaJJJWRp60op3ZOoK7UaO5I7zi33rdKQGgHylR.png",
  "message": "Hey %FIRST_NAME%!,\n\nTHANK YOU for allowing us the opportunity to HELP you with your plan!",
  "handwriting_style": 4,
  "recipients": [
    {
      "name": "Current Resident",
      "address": "123 Main Street",
      "city": "Fake City",
      "province": "NY",
      "postal_code": "55555",
      "country": "US",
      "custom1": "Example Custom 1",
      "custom2": "Example Custom 2",
      "custom3": "Example Custom 3",
      "custom4": "Example Custom 4"
    },
    {
      "name": "Jane Doe",
      "address": "456 Another St",
      "city": "Fake City",
      "province": "NY",
      "postal_code": "55555",
      "country": "US"
    }
  ]
}'

{
  "total_estimated_recipients": 2,
  "authorization_total": 116,
  "leads_fee": 0,
  "mailing_list_ids_used": "3046,3020",
  "handwriting_color": "rgba(31,0,113,0.80)",
  "front_image": "https://s3.amazonaws.com/cdn.thanks.io/user_image_library/1533645532.png",
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "append_or_current_resident": true,
  "type": "postcard",
  "return_name": null,
  "return_address": null,
  "return_address2": null,
  "return_city": null,
  "return_province": null,
  "return_postal_code": null,
  "message_template_id": null,
  "image_template_id": 6,
  "method": "api",
  "sub_account_id": null,
  "font_size": "auto",
  "qrcode_url": "https://www.google.com?name=~FULL_NAME~&custom_field_1=~CUSTOM1~&custom_field2=~CUSTOM2~",
  "size": "4x6",
  "custom_background_url": "https://s3.amazonaws.com/content-staging.thanks.io/templates/branding-builder-images/c09d39aadfc-3701d4467b8/4524cce0-78cb-11f0-b937-17570cbedaf4.png",
  "giftcard_brand": null,
  "giftcard_image": null,
  "giftcard_amount": null,
  "status": "reviewing",
  "addons": {
    "standardmail": "on"
  },
  "style": 4,
  "user_id": 2,
  "updated_at": "2025-08-14 16:48:13",
  "created_at": "2025-08-14 16:48:13",
  "id": 42665,
  "display_status": "Reviewing",
  "display_trigger": "API",
  "display_type": "Postcard-4x6",
  "handwriting_image": null,
  "giftcard_brand_longname": "",
  "sub_account": null
}

POST

send

postcard

curl --request POST \
  --url https://api.thanks.io/api/v2/send/postcard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "size": "4x6",
  "front_image_url": "https://s3.amazonaws.com/cdn.thanks.io/user_image_library/gFBaJJJWRp60op3ZOoK7UaO5I7zi33rdKQGgHylR.png",
  "message": "Hey %FIRST_NAME%!,\n\nTHANK YOU for allowing us the opportunity to HELP you with your plan!",
  "handwriting_style": 4,
  "recipients": [
    {
      "name": "Current Resident",
      "address": "123 Main Street",
      "city": "Fake City",
      "province": "NY",
      "postal_code": "55555",
      "country": "US",
      "custom1": "Example Custom 1",
      "custom2": "Example Custom 2",
      "custom3": "Example Custom 3",
      "custom4": "Example Custom 4"
    },
    {
      "name": "Jane Doe",
      "address": "456 Another St",
      "city": "Fake City",
      "province": "NY",
      "postal_code": "55555",
      "country": "US"
    }
  ]
}'

{
  "total_estimated_recipients": 2,
  "authorization_total": 116,
  "leads_fee": 0,
  "mailing_list_ids_used": "3046,3020",
  "handwriting_color": "rgba(31,0,113,0.80)",
  "front_image": "https://s3.amazonaws.com/cdn.thanks.io/user_image_library/1533645532.png",
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "append_or_current_resident": true,
  "type": "postcard",
  "return_name": null,
  "return_address": null,
  "return_address2": null,
  "return_city": null,
  "return_province": null,
  "return_postal_code": null,
  "message_template_id": null,
  "image_template_id": 6,
  "method": "api",
  "sub_account_id": null,
  "font_size": "auto",
  "qrcode_url": "https://www.google.com?name=~FULL_NAME~&custom_field_1=~CUSTOM1~&custom_field2=~CUSTOM2~",
  "size": "4x6",
  "custom_background_url": "https://s3.amazonaws.com/content-staging.thanks.io/templates/branding-builder-images/c09d39aadfc-3701d4467b8/4524cce0-78cb-11f0-b937-17570cbedaf4.png",
  "giftcard_brand": null,
  "giftcard_image": null,
  "giftcard_amount": null,
  "status": "reviewing",
  "addons": {
    "standardmail": "on"
  },
  "style": 4,
  "user_id": 2,
  "updated_at": "2025-08-14 16:48:13",
  "created_at": "2025-08-14 16:48:13",
  "id": 42665,
  "display_status": "Reviewing",
  "display_trigger": "API",
  "display_type": "Postcard-4x6",
  "handwriting_image": null,
  "giftcard_brand_longname": "",
  "sub_account": null
}

Authorizations

Authorization

string

header

required

Bearer token authentication using your thanks.io API key

Body

application/json

preview

boolean

Set to true to preview the postcard instead of sending it. This can be used with any send call to get a preview before sending.

Example:

true

mailing_lists

integer[]

ID of mailing list to sent to. Required if recipients and radius_search is not specified.

Example:

[5166, 514]

recipients

(Create Recipient by Address · object | Create Recipient by Email · object)[]

Array of recipients to send to. Required if mailing_lists and radius_search is not specified.

Create Recipient by Address
Create Recipient by Email

Show child attributes

radius_search

object

Search for recipients within a radius of a given address. Required if mailing_lists and recipients are not specified. There is a $.05 lookup fee for each record.

Show child attributes

handwriting_style

integer

ID of handwriting style to use.

Example:

4

handwriting_color

enum<string>

Handwriting color to use. Options are preset named colors or specified as hex format, such as '#4287f5'

Available options:

blue,

black,

green,

purple,

red

Examples:

"blue"

"#4287f5"

handwriting_realism

boolean

Boolean, set to true to turn on the realism effect for AI fonts.

Example:

true

sub_account

integer

ID of Sub Account to use for this order.

Example:

7

email_additional

string

Optional email to send alerts to about order (such as QR scan notifications).

Example:

"[email protected]"

send_standard_mail

boolean

default:false

Send Mail as Standard Mail postage class. If false or not specified, First Class postage will be used.

return_name

string

Custom return name for the order.

Example:

"Custom Return"

return_address

string

Custom return address for the order.

Example:

"1 Main Street"

return_address2

string

Custom return address line 2 for the order.

Example:

"Unit 1"

return_city

string

Custom return city for the order.

Example:

"Woodbridge"

return_state

string

Custom return state/province for the order.

Example:

"NJ"

return_postal_code

string

Custom return postal code for the order.

Example:

"07095"

image_template

integer

ID of image template to use for front of postcard. Required if front_image_url is not specified.

Example:

6

front_image_url

string

URL to image to use for front of postcard. Must be 1875px by 1275px for 4x6/6x9 postcards or 3337px x 1777px for 6x11 Postcards. Required if image_template is not specified.

Example:

"https://s3.amazonaws.com/cdn.thanks.io/user_image_library/gFBaJJJWRp60op3ZOoK7UaO5I7zi33rdKQGgHylR.png"

message

string

Handwritten message content used for content on back of postcard.

Example:

"Hey %FIRST_NAME%!,\n\nTHANK YOU for allowing us the opportunity to HELP you with your plan!"

message_template

integer

ID of message template to use for content on back of postcard.

Example:

12

use_custom_background

boolean

default:false

Use custom background image. This can be used to turn off the default background image.

custom_background_image

string

URL to custom background image to use for back of postcard. This image will be placed behind the handwritten message. Must be 1875px by 1275px for 4x6/6x9 postcards or 3337px x 1777px for 6x11 Postcards.

Example:

"https://s3.amazonaws.com/cdn.thanks.io/user_image_library/gFBaJJJWRp60op3ZOoK7UaO5I7zi33rdKQGgHylR.png"

qrcode_url

string

URL to Autogenerate QR Code on back of postcard. If not specified, account default QR code URL will be used.

Example:

"https://www.google.com"

size

enum<string>

default:4x6

Size of the postcard.

Available options:

4x6,

6x9,

6x11

Response

Send Mailer Success

Send Mailer Order Submitted Response
Send Mailer Preview Response

Response when an Order is successfully submitted to Send Mailer

integer

Unique identifier for the order

Example:

42664

user_id

integer

User ID for the order

Example:

2

sub_account

object

Sub-account Info For Order. Can be null

Show child attributes

sub_account_id

integer | null

Sub account ID for the order

Example:

12345

total_estimated_recipients

integer

Total estimated recipients for the order

Example:

1

authorization_total

integer

Total authorization amount for the order in cents

Example:

58

leads_fee

integer

Total leads fee for the order in cents

Example:

99

mailing_list_ids_used

string

Mailing lists used for the order. Can be null if recipients or radius search is used.

Example:

"3046,3020"

recipients

object[]

List of recipients for the order

Show child attributes

front_image

string

Front image URL for the order

Example:

"https://s3.amazonaws.com/cdn.thanks.io/user_image_library/1533645532.png"

image_template_id

integer | null

Image template ID for the order

Example:

6

custom_background_url

string | null

Custom background URL for the order

Example:

"https://s3.amazonaws.com/content-staging.thanks.io/templates/branding-builder-images/c09d39aadfc-3701d4467b8/4524cce0-78cb-11f0-b937-17570cbedaf4.png"

message

string

Message content for the order

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

message_template_id

integer | null

Message template ID for the order

Example:

12345

handwriting_color

string

Handwriting color to use

Example:

"rgba(31,0,113,0.80)"

font_size

enum<string>

Font size for the order

Available options:

auto,

small,

medium,

large

Example:

"auto"

style

integer

Handwriting style ID for the order

Example:

4

append_or_current_resident

boolean

Appended "Or Current Resident" for the order. This is helpful if you want to ensure delivery.

Example:

false

return_name

string | null

Return name for the order

Example:

"John Doe"

return_address

string | null

Return address line 1 for the order

Example:

"123 Main Street"

return_address2

string | null

Return address line 2 for the order

Example:

null

return_city

string | null

Return city for the order

Example:

"Anytown"

return_province

string | null

Return state/province for the order

Example:

"NY"

return_postal_code

string | null

Return postal code for the order

Example:

"12345"

type

enum<string>

Type of the order

Available options:

postcard,

postcard6x11,

letter,

notecard,

giftcard,

windowlessletter

Example:

"postcard"

size

enum<string>

Size of the order (valid for postcards only)

Available options:

4x6,

6x9,

6x11

Example:

"4x6"

method

enum<string>

Method for the order

Available options:

api,

cardbuilder,

drip,

email,

zapier

status

enum<string>

Status of the order

Available options:

reviewing,

processing,

fulfilled,

cancelled,

printed,

shipped,

paused,

delivered

display_status

string

Display status for the order

Example:

"Reviewing"

display_trigger

string

Display trigger for the order

Example:

"API"

display_type

string

Display type for the order

Example:

"Postcard-4x6"

addons

object | null

Add-ons for the order

Show child attributes

qrcode_url

string | null

QR code URL for the order

Example:

"https://www.google.com?name=~FULL_NAME~&custom_field_1=~CUSTOM1~&custom_field2=~CUSTOM2~"

giftcard_brand

string | null

Gift card brand for the order (valid for Giftcard orders only)

Example:

null

giftcard_image

string | null

Gift card image URL for the order (valid for Giftcard orders only)

Example:

null

giftcard_amount

integer | null

Gift card amount for the order in cents (valid for Giftcard orders only)

Example:

null

giftcard_brand_longname

string

Gift card brand long name for the order (valid for Giftcard orders only)

Example:

"Amazon.com"

updated_at

string<date-time>

Last updated timestamp for the order

Example:

"2025-08-14 16:42:44"

created_at

string<date-time>

Creation timestamp for the order

Example:

"2025-08-14 16:42:44"

Usage Send Windowed Letter

⌘I

Get Started

Authentication

Endpoints

Examples

Authorizations

Body

Response