Skip to navigation
Email APIEmail templates

Returns the template information

View as Markdown

Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a doiTemplate flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Path parameters

templateIdlong or stringRequired

ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter).

Response

Email template informations
createdAtstring

Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)

htmlContentstring
HTML content of the template
idlong
ID of the template
isActiveboolean

Status of template (true=active, false=inactive)

modifiedAtstring

Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)

namestring
Name of the template
replyTostringformat: "email"
Email defined as the "Reply to" for the template
senderobject
subjectstring
Subject of the template
tagstring
Tag of the template
testSentboolean

Status of test sending for the template (true=test email has been sent, false=test email has not been sent)

toFieldstring
Customisation of the "to" field for the template
doiTemplatebooleanOptional

It is true if template is a valid Double opt-in (DOI) template, otherwise it is false. This field will be available only in case of single template detail call.

customTemplateIdstringOptional
Custom template identifier, if one was assigned during template creation. Only present when the template has a custom ID.

Errors

400
Bad Request Error
404
Not Found Error