Templates

Get template information

Retrieve template content and information

get/v1/templates/template/{template}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/templates/template/{template}
  • Auth: HTTP bearer

Path parameters

templatestring required

Template ID

Example:example

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the template, including its content.

accountstring nullable required

Account ID. Null for public templates

idstring required

Template ID

namestring required

Name of the template

descriptionstring

Optional description of the template

format'html' | 'markdown'

Markup language for HTML ("html" or "markdown")

createdstring date-time

The time this template was created

updatedstring date-time

The time this template was last updated

Example response

{
  "account": "user123",
  "id": "AAABgS-UcAYAAAABAA",
  "name": "Transaction receipt",
  "description": "Something about the template",
  "created": "2021-02-17T13:43:18.860Z",
  "updated": "2021-02-17T13:43:18.860Z",
  "content": {
    "subject": "What a wonderful message",
    "text": "Hello from myself!",
    "html": "<p>Hello from myself!</p>",
    "previewText": "Welcome to our newsletter!"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.