Skip to main content
POST
Create Message Template

Authorizations

Authorization
string
header
required

Bearer token authentication using your thanks.io API key

Body

application/json
type
enum<string>

Type of the message template

Available options:
postcard,
postcard6x11,
letter,
windowlessletter,
notecard,
giftcard,
magnacard
Example:

"notecard"

name
string

Name of the message template

Example:

"Thank You Message"

handwriting_style_id
integer

Handwriting style ID for the message template

Example:

4

font_color
string

Handwriting color to use

Example:

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

handwriting_realism
boolean

Set to true to enable the realism effect for AI fonts.

Example:

true

content
string

Template body content.

Example:

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

sub_account_id
integer | null

ID of the sub-account to associate with this template.

Example:

7

additional_pages
string<uri>

URL to additional pages to include with the cover letter. Only valid for letter templates.

Example:

"https://example.com/additional-pages.pdf"

pdf_only_url
string<uri>

URL to PDF file to use for entire mailer. If this is specified, no cover letter is generated. Valid for letter templates only. Providing this URL automatically sets skip_creative_generation to true.

Example:

"https://example.com/mailer.pdf"

custom_background_url
string<uri>

URL of a custom background image for the template. Only valid for postcard backs and the interior background of notecards and giftcards.

Example:

"https://example.com/background.png"

qrcode_url
string<uri>

URL of the QR code image to use for the template.

Example:

"https://www.thanks.io"

cc_emails
string<email>[]

List of email addresses to CC when a QR code is scanned

giftcard_brand_code
string

Brand code of the gift card. Required when type is giftcard.

Example:

"amazonus"

giftcard_amount
integer

Amount of the gift card in cents. Required when type is giftcard. Use this field for public v2 requests instead of giftcard_amount_in_cents.

Example:

5000

landing_page_url
string<uri>

URL of the gated landing page (also known as a gating URL). Recipients must visit this page before they can redeem the gift card, letting you gate redemption behind an action such as booking a demo or completing a form. Only valid for giftcards.

Example:

"https://example.com/landing"

Response

Created

id
integer
Example:

2

user_id
integer
Example:

2

sub_account_id
integer | null
handwriting_style_id
integer

ID of the handwriting style used in the message template

Example:

18

font_size
enum<integer>

Font size used in the message template. Only valid for AI fonts

Available options:
auto,
large,
medium,
small
font_color
string

Font color used in the message template.

Example:

"#000000"

handwriting_realism
boolean

Handwriting realism level used in the message template. Only valid for AI fonts

name
string
Example:

"Thank You Message"

content
string
Example:

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

additional_pages
string<uri>

URL to additional pages to include with the cover letter. Only valid for letter templates.

skip_creative_generation
integer

Flag to skip creative generation. Set when message template is PDF file only.

Example:

0

custom_background_url
string

URL of the custom background image for the message template. Only valid for postcard backs and the interior background of notecards and giftcards.

Example:

"https://example.com/background.png"

qrcode_url
string

URL of the QR code image for the message template

Example:

"https://www.thanks.io"

cc_emails
string<email>[]

List of email addresses to be CC'd on when a QR code is scanned

created_at
string<date-time>
Example:

"2018-08-08T02:56:59.000000Z"

updated_at
string<date-time>
Example:

"2025-02-12T05:13:15.000000Z"

type
enum<string>

Type of the message template

Available options:
postcard,
postcard6x11,
letter,
windowlessletter,
notecard,
giftcard,
magnacard
Example:

"notecard"

giftcard_brand_code
string

Brand code of the gift card

Example:

"amazonus"

giftcard_brand_image
string

Image URL of the gift card brand

Example:

"https://cdn.thanks.io/giftcards/amazonus.png"

giftcard_amount
integer

Amount of the gift card in cents

Example:

5000

landing_page_url
string<uri>

URL of the gated landing page (also known as a gating URL). Recipients must visit this page before they can redeem the gift card, letting you gate redemption behind an action such as booking a demo or completing a form. Only valid for giftcards.

share_uuid
string
Example:

"5J5N-QAD3-6LLL-LSZZ"