List Image Templates API

List Image Templates API


This API endpoint will provide a list of the users active image templates.


Base API URL:


https://app.hyperise.io/api/v1/regular/image-templates?api_token=<your_token>



Input:


 Label Key Type Required
 API Token api_token String 



Learn more here on how to generate your Hyperise API token.


The API will provide a JSON output.


Example Output:


Key

Example

id

100308

image_hash

RvQHa4kJk

name

My new image

width

753

height

535

preview_image          

https:\/\/storage.googleapis.com\/growthlist-storage\/app\/images\/users\/3\/editor\/preview\/image_1594233630_5727.png

base_url

https:\\img.hyperi.se

image_url

\i\RvQHa4kJk.png

created_at

2020-07-08T18:38:50Z

updated_at

2020-07-08T18:40:30Z



Use the preview_image output to show the template preview to the users, to aid in selection.



Using the base_url + image_url will provide the full dynamic image URL, to this URL you can then apply the standard Hyperise URL parameters.


Eg:


https:\\img.hyperi.se\i\RvQHa4kJk.png?email=&first_name=&website=&business_name=



The full list of standard Hyperise URL parameters are:



URL ParameterNotes
Demographic title

first_name

last_name
gender

profile_url
Image URL of the prospects profile image
job_title

email
phone
home_phone

Firmographicbusiness_name
category
website
fb_id
Facebook Business Page ID
logo
Image URL of the business logo image
business_phone

business_address

employees_range

revenue
Geographiclat

long

street

street2

city

state

country

zip

Customcustom_text_1
Used to push for custom text parameters within the image.
custom_text_2
custom_text_3
custom_text_4
custom_text_5
custom_image_1
Used to push for custom image URL parameters within the image.
custom_image_2
custom_image_3





Discover other Hyperise APIs:


  1. User Authentication - Authorise the API token.
  2. Image Impressions - List the most recent personalised impressions for selected image.
  3. Business Data - Add/Update/View prospect data for images to use.
  4. Short Links - Create personalised Short Links.
  5. Data Enrichment - provides enriched data from an email input.