Dynamic Images

Create

Changed on

Build image for the front of your postcard or notecard. Includes ability to set dynmiac fields and QR code. This does not create an order, it simply builds the image and returns a URL to the image. You can then use this image URL in your order creation request.

Dynamic Data Tags

Use these tags in your header, sub-header, background image URL, and QR Code/Redirect URL to have recipient data automatically added further personalizing each postcard.

  • ~FULL_NAME~
  • ~FIRST_NAME~
  • ~COMPANY~
  • ~ADDRESS~
  • ~ADDRESS2~
  • ~CITY~
  • ~STATE~
  • ~ZIP~
  • ~EMAIL~
  • ~PHONE~
  • ~CUSTOM1~
  • ~CUSTOM2~
  • ~CUSTOM3~
  • ~CUSTOM4~
  • ~YOUR_FULL_NAME~
  • ~YOUR_FIRST_NAME~
  • ~YOUR_COMPANY~
  • ~YOUR_EMAIL~
  • ~YOUR_PHONE~
get/build/image-template

Request

  • Base URL: https://api.thanks.io/api/v2
  • URL: https://api.thanks.io/api/v2/build/image-template
  • Auth: HTTP bearer

Query parameters

idinteger required

Template ID to use

background_urlstring
Example:~STREET_VIEW~

Background Image URL sits behind the generated dynamic image. Can be one of the following

  • ~MAP_VIEW~ for Google Map View.
  • ~STREET_VIEW~ for Google Street View.
  • Valid HTTP png or jpg URL
headerstring
Example:Want to Know ~ADDRESS~'s Value?

Header Text - Taggable

subheaderstring
Example:Scan the QR code to get an immediate value for ~ADDRESS~.

Sub-header Text - Taggable

redirect_urlstring
Example:https://thanks.io

Location to redirect recipeint to on QR Code Scan. Can be one of the following

  • ~MESSAGE_QR~ for Message Template QR Code
  • Valid http URL
logo_urlstring
Example:https://cdn.thanks.io/assets/brand/logo%402x.png

Image Logo to use. Can be one of the following

  • ~YOUR_LOGO~ for your branding logo
  • ~YOUR_SYMBOL~for your branding symbol
  • Valid HTTP png or jpg URL
overlay_urlstring
Example:https://s3.amazonaws.com/content.thanks.io/templates/dynamic-images/b96a8260-34ce-11f0-b5f2-81d9e83ce1aa.png

Overlay Image URL sits in front of the generated dynamic image. Must be 1875x1275 png or jpg, or 2738x1838 when size is 6x9.

size'4x6' | '6x9'
Example:6x9

Canvas to render the image at. 4x6 renders 1875x1275 for 4x6 postcards; 6x9 renders 2738x1838 for 6x9 postcards.

Response

Successful Response

Changes