GET
/
build
/
image-template
Create
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thanks.io/api/v2/build/image-template', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
integer
required

Template ID to use

Required range: 1 <= x <= 18
Example:

"8"

​
background_url
string

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
Example:

"~STREET_VIEW~"

​
header
string

Header Text - Taggable

Example:

"Want to Know ~ADDRESS~'s Value?"

​
subheader
string

Sub-header Text - Taggable

Example:

"Scan the QR code to get an immediate value for ~ADDRESS~."

​
redirect_url
string

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
Example:

"https://www.thanks.io"

​
logo_url
string

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
Example:

"https://d2md0c8rpvzmz5.cloudfront.net/assets/brand/logo%402x.png"

​
overlay_url
string

Overlay Image URL sits in front of the generated dynamic image. Must be 1875x1275 png or jpg.

Example:

"https://s3.amazonaws.com/content.thanks.io/templates/dynamic-images/b96a8260-34ce-11f0-b5f2-81d9e83ce1aa.png"

Response

200 - image/png

Successful Response

The response is of type file.