POST GET templates/search

Search email templates

* required

Parameters

Name	Type	Description
userID	integer	Get templates for a specific user
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 50
sortField	string	The field to sort results by Default: templateName Allowed Values: templateID, templateName, editableSlots
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Response Data

Name	Type	Description
templateID	integer	Unique ID of an email template
templateName	string	Descriptive name of template
editableSlots	string	Number of editable slots in template
thumbnail	string	URL to thumbnail image
overrideApprovalProcess	boolean	Emails created from this template will not require approval, overriding account-level settings for email approvals

Example Calls

All templates

GET

/templates/search

cURL

Copy

curl https://api.emailer.emfluence.com/v1/templates/search \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":20,"totalPages":1,"totalRecords":3,"prev":""},"records":[{"editableSlots":1,"overrideApprovalProcess":0,"templateID":123,"templateName":"Default","thumbnail":"https://emailer.emfluence.com/clients/sampleclient/templates/images/default.gif"},{"editableSlots":5,"overrideApprovalProcess":0,"templateID":456,"templateName":"Newsletter","thumbnail":"https://emailer.emfluence.com/clients/sampleclient/templates/images/newsletter.gif"},{"editableSlots":1,"overrideApprovalProcess":0,"templateID":789,"templateName":"Feature Update","thumbnail":"https://emailer.emfluence.com/clients/sampleclient/templates/images/feature.gif"}]},"code":0,"requestID":"20D3BB54-D769-4A59-B21389151DCA21CB"}

Templates for a given user

GET

/templates/search?userID=123

cURL

Copy

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

Response Data

{"success":1,"data":{"paging":{"next":"","page":1,"rpp":20,"totalPages":1,"totalRecords":2,"prev":""},"records":[{"editableSlots":5,"overrideApprovalProcess":0,"templateID":456,"templateName":"Newsletter","thumbnail":"https://emailer.emfluence.com/clients/sampleclient/templates/images/newsletter.gif"},{"editableSlots":1,"overrideApprovalProcess":0,"templateID":789,"templateName":"Feature Update","thumbnail":"https://emailer.emfluence.com/clients/sampleclient/templates/images/feature.gif"}]},"code":0,"requestID":"E238BE49-0030-41C2-94DCEF279A0925CC"}

API Console

The console uses production data, so BE CAREFUL!

GET

templates/search

Param	Type	Description
userID	integer	Get templates for a specific user
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 50
sortField	string	The field to sort results by Default: templateName Allowed Values: templateID, templateName, editableSlots
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

Email Templates

POST GET templates/search

Parameters

Response Data

Example Calls

All templates

Templates for a given user

API Console