Postcard Order

Below are two of the many ways the endpoint can be used. There is extensive flexibility - see the Send Mailer Usage Page for details on all options.

Send a Creative (Recommended)

Design the postcard once as a creative in your dashboard, then send it by ID. The creative supplies the front design, the message, the handwriting, and the background, so the request only needs your audience.

Find the Creative

List your complete 4x6 postcard creatives and note the id of the one you want to send. You can also copy the ID from the creative’s card menu (Copy creative ID) in the dashboard.See List Creatives for more info.

curl -X GET "https://api.thanks.io/api/v2/creatives?mailer_type=postcard&complete_only=1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Send the Creative

Pass the ID as creative_id with your recipients, as a number. Replace 501 below with the ID from the previous step.

curl -X POST "https://api.thanks.io/api/v2/send/postcard" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "creative_id": 501,
    "recipients": [
      {
        "name": "Jane Doe",
        "address": "456 Another St",
        "city": "Fake City",
        "province": "NY",
        "postal_code": "55555",
        "country": "US"
      }
    ]
  }'

A creative sends exactly as saved, so leave out the image, message, handwriting, and background parameters. You can still add qrcode_url. For a 6x9 or 6x11 creative, list with mailer_type=postcard6x9 or postcard6x11 and send with the matching size (6x9 or 6x11); when you leave size out, the send uses your account’s default postcard size. See Send a Creative for the full rules.

Send an Image and Message

To build the postcard in the request instead, pass the front image and the message directly:

  curl -X POST "https://api.thanks.io/api/v2/send/postcard" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -d '{ 
      "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"
        }
      ]
    }'

Get Started

Common Workflows

FAQs

Send a Creative (Recommended)

Send an Image and Message

​Send a Creative (Recommended)

​Send an Image and Message

Send a Creative (Recommended)

Send an Image and Message