v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
TEMPLATES

Add an email template

Adds a new email template that you can use to format your emails.

post/template/add

Request body

template_namestring required

The name of the email template. Min length: 1 Character. Max length: 64 Characters.

idstring required

The case-sensitive ID of the email template. Min length: 5 Character. Max length: 24 Characters.

subjectstring required

The subject of the email template.

html_bodystring required

The HTML body of the email template.

text_bodystring required

The Plain Text body of the email template.

template_variablesobject

The variables to use within this email template in the format {"variable1": "value1", "variable2": "value2"}

tagsstring[]

The list of Tags to associate to this email template

Response

Template added

request_idstring

Example response

{
  "request_id": "f00c0856-dde8-11eb-b4ce-1002b51e60a4",
  "data": {
    "id": "5355878",
    "name": "Order receipt",
    "template_name": "Order receipt",
    "subject": "Order receipt for {{ product_name }}",
    "tags": [
      "one"
    ],
    "last_updated": "2024-01-01 12:00:00"
  }
}