Create Template

POST 
/template

Creates a new saved template for your account

• name - Required. Unique within the account, up to 256 characters.
• subject - Optional, up to 150 characters. Default subject for campaigns created from the template.
• previewText - Optional, up to 150 characters. Default preview text (preheader) for campaigns created from the template.
• html - Required. Full HTML of the email.
• css - Optional. Defaults to empty.

Templates created through the API open in the HTML editor in the app (editorType is always HTML).

Request

application/json

Body

required

name stringrequired

Possible values: <= 256 characters

Template name, unique within the account

subject string

Possible values: <= 150 characters

Default subject for campaigns created from this template

previewText string

Possible values: <= 150 characters

Default preview text (preheader) for campaigns created from this template

html stringrequired

Full HTML of the email

css string

Optional CSS kept alongside the HTML. Defaults to empty.

Responses

201

Template created

application/json

Schema

Schema

id uuid
name string
subject stringnullable
previewText stringnullable
html string
css string
editorType string

Possible values: [DRAG_AND_DROP, HTML]

Editor the template opens in. Always HTML for templates created through the API.

createdAt int64

Creation time in epoch milliseconds

updatedAt int64

Last update time in epoch milliseconds

Example (from schema)

{
  "id": "8a6e0f6c-2b7d-4a8e-9a5e-6f1d2c3b4a59",
  "name": "Welcome Email",
  "subject": "Welcome!",
  "previewText": "Thanks for joining us",
  "html": "<html><body><h1>Welcome</h1></body></html>",
  "css": "h1 { color: #333333; }",
  "editorType": "HTML",
  "createdAt": 1790848800000,
  "updatedAt": 1790848800000
}

412

Precondition Failed. The template was not found in your account, or the request failed validation: a duplicate name (errorCodes[0].errorCode = 4.4.001), a missing name or html, or a field over its maximum length.

application/json

Schema

Schema

message string
messageDetails string
errorCodes object[]
Array [
errorCode string
errorMessage string
]

Example (from schema)

{
  "message": "Some error message",
  "messageDetails": "string",
  "errorCodes": [
    {
      "errorCode": "string",
      "errorMessage": "string"
    }
  ]
}

Duplicate name

{
  "message": "Template with name 'Welcome Email' already exists for this account!",
  "errorCodes": [
    {
      "errorCode": "4.4.001",
      "errorMessage": "Template with name 'Welcome Email' already exists for this account!"
    }
  ]
}

Missing field

{
  "message": "name must not be blank"
}

Field too long

{
  "message": "subject may not exceed 150 characters"
}

Template not found

{
  "message": "Template 8a6e0f6c-2b7d-4a8e-9a5e-6f1d2c3b4a59 not found"
}

Loading...