POST GET templates/lookup

Get full details for email templates

* required

Parameters

Name	Type	Description
templateID	integer	Unique ID of a template
templateIDs	array[integer]	Multiple templateIDs. Requests that use this parameter will change the response data from a single object to an array of objects.

Response Data

Returns a fully populated template object, or an array of template objects if looking up multiple templateIDs

Name

Type

Description

dateAdded

datetime

dateModified

datetime

defaults

struct

Default properties applied to all emails that use this template

fromAddress	string
fromName	string
replyToAddress	string
replyToName	string
subject	string
title	string

editableSlots

string

Number of editable slots in template

htmlHeadEditable

boolean

Template allows <head> content of HTML version to be edited

htmlVersion

string

HTML version of template

overrideApprovalProcess

boolean

Emails created from this template will not require approval, overriding account-level settings for email approvals

previewHTML

string

Deprecated - use htmlVersion property. HTML version of template with placeholders for editable slots

templateID

integer

Unique ID of an email template

templateName

string

Descriptive name of template

textVersion

string

Text version of template

thumbnail

string

URL to thumbnail image

type

string

HTML or Text. HTML templates can have both an htmlVersion and a textVersion

userIDs

array[integer]

Users who have access to send emails using this template

Example Calls

Lookup template by ID

GET

/templates/lookup?templateID=123

cURL

Copy

curl https://api.emailer.emfluence.com/v1/templates/lookup?templateID=123 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{
    "success": 1,
    "data": {
        "previewHTML": "[Contains full HTML preview of template with placeholders for editable slots]",
        "editableSlots": 1,
				"overrideApprovalProcess": 0,
        "templateID": 123,
        "templateName": "Default",
		"thumbnail": "https://emailer.emfluence.com/clients/sampleclient/templates/images/default.gif",
        "userIDs": [
            123,
            456,
            789
        ],
		"defaults": {
		    "fromAddress": "",
		    "fromName": "",
		    "replyToName": "",
		    "replyToAddress": "",
		    "subject": "",
		    "title": "",
		    "content": {
		        "body_slot4": "",
		        "body_slot3": "",
		        "body_slot6": "",
		        "body_slot5": "",
		        "body_slot8": "",
		        "body_slot7": "",
		        "body_slot10": "",
		        "body_slot9": "",
		        "body_slot2": "",
		        "body_slot1": ""
		    }
		}
    },
    "code": 0
}

Lookup multiple templates by array of templateIDs

POST

/templates/lookup

cURL

Copy

curl https://api.emailer.emfluence.com/v1/templates/lookup \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"templateIDs": [123,456,789]
	}'

Response Data

{
    "success": 1,
    "data": [
        {
            "previewHTML": "[Contains full HTML preview of template with placeholders for editable slots]",
            "editableSlots": 1,
						"overrideApprovalProcess": 0,
            "templateID": 123,
            "templateName": "API Example Template 1",
			"thumbnail": "https://emailer.emfluence.com/clients/sampleclient/templates/images/template1.gif",
            "userIDs": [
                123,
                456,
                789
            ],
			"defaults": {
			    "fromAddress": "",
			    "fromName": "",
			    "replyToName": "",
			    "replyToAddress": "",
			    "subject": "",
			    "title": "",
			    "content": {
			        "body_slot4": "",
			        "body_slot3": "",
			        "body_slot6": "",
			        "body_slot5": "",
			        "body_slot8": "",
			        "body_slot7": "",
			        "body_slot10": "",
			        "body_slot9": "",
			        "body_slot2": "",
			        "body_slot1": ""
			    }
			}
        },
        {
            "previewHTML": "[Contains full HTML preview of template with placeholders for editable slots]",
            "editableSlots": 1,
						"overrideApprovalProcess": 0,
            "templateID": 456,
            "templateName": "API Example Template 2",
			"thumbnail": "https://emailer.emfluence.com/clients/sampleclient/templates/images/template2.gif",
            "userIDs": [
                123,
                456,
                789
            ],
			"defaults": {
			    "fromAddress": "",
			    "fromName": "",
			    "replyToName": "",
			    "replyToAddress": "",
			    "subject": "",
			    "title": "",
			    "content": {
			        "body_slot4": "",
			        "body_slot3": "",
			        "body_slot6": "",
			        "body_slot5": "",
			        "body_slot8": "",
			        "body_slot7": "",
			        "body_slot10": "",
			        "body_slot9": "",
			        "body_slot2": "",
			        "body_slot1": ""
			    }
			}
        },
        {
            "previewHTML": "[Contains full HTML preview of template with placeholders for editable slots]",
            "editableSlots": 1,
						"overrideApprovalProcess": 0,
            "templateID": 789,
            "templateName": "API Example Template 3",
			"thumbnail": "https://emailer.emfluence.com/clients/sampleclient/templates/images/template3.gif",
            "userIDs": [
                123,
                456,
                789
            ],
			"defaults": {
			    "fromAddress": "",
			    "fromName": "",
			    "replyToName": "",
			    "replyToAddress": "",
			    "subject": "",
			    "title": "",
			    "content": {
			        "body_slot4": "",
			        "body_slot3": "",
			        "body_slot6": "",
			        "body_slot5": "",
			        "body_slot8": "",
			        "body_slot7": "",
			        "body_slot10": "",
			        "body_slot9": "",
			        "body_slot2": "",
			        "body_slot1": ""
			    }
			}
        }
    ],
    "code": 0
}

API Console

The console uses production data, so BE CAREFUL!

GET

templates/lookup

Param	Value	Type	Description
templateID		integer	Unique ID of a template
templateIDs		array[integer]	Multiple templateIDs. Requests that use this parameter will change the response data from a single object to an array of objects.

Access token: *

Email Templates

POST GET templates/lookup

Parameters

Response Data

Example Calls

Lookup template by ID

Lookup multiple templates by array of templateIDs

API Console