Skip to main content
POST
/
template
/
email
curl --request POST \
  --url https://api.sendx.io/api/v1/rest/template/email \
  --header 'Content-Type: application/json' \
  --header 'X-Team-ApiKey: <api-key>' \
  --data '{
  "name": "Weekly Newsletter Template",
  "htmlCode": "<div class=\"newsletter\"><h1>{{company.name}} Weekly Update</h1><div class=\"content\">{{email.content}}</div></div>",
  "templateCode": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null,\"showIfKey\":null},\"content\":[{\"type\":\"text\",\"text\":\"This is a new template\"}]}]}",
  "editorType": 1
}'
{
  "id": "template_abc123def456ghi789",
  "name": "Welcome Email Template",
  "subject": "Welcome to our platform!",
  "htmlCode": "<html><body><h1>Welcome!</h1></body></html>",
  "templateCode": "{\"blocks\":[{\"type\":\"text\",\"content\":\"Welcome!\"}]}",
  "type": 0,
  "thumbnail": "https://cdn.sendx.io/templates/thumb_abc123.png",
  "editorType": 1,
  "created": "2024-01-10T14:20:00Z",
  "updated": "2024-01-15T09:15:00Z"
}
🎯 Key Features:
  • HTML and text versions
  • Personalization variables
  • Reusable across campaigns
  • Template versioning
🎨 Editor-Specific Features:
  • PlainText (0): Basic text formatting, fast loading
  • DragDrop (1): Visual components, responsive design using the bee editor
  • SendxEditor (2): TipTap editor with advanced features like drag & drop, image upload, and more
✨ Template Benefits:
  • Reusable email designs
  • Consistent branding across campaigns

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Body

application/json
​
name
string
required

Template name

Example:

"Welcome Email Template"

​
htmlCode
string

HTML email content

​
templateCode
string

Template code for the selected template type

​
editorType
integer

Editor type used to create the template.

Values:

  • 0 - PlainText
  • 1 - DragDrop
  • 2 - SendxEditor

Response

✅ Template created successfully

​
id
string

Unique template identifier with template_ prefix

Example:

"template_abc123def456ghi789"

​
name
string

Name of the template

Example:

"Welcome Email Template"

​
subject
string | null

Email subject line (if applicable)

Example:

"Welcome to our platform!"

​
htmlCode
string

HTML content of the template

Example:

"<html><body><h1>Welcome!</h1></body></html>"

​
templateCode
string | null

Template code for visual editors (JSON structure)

Example:

"{\"blocks\":[{\"type\":\"text\",\"content\":\"Welcome!\"}]}"

​
type
integer

Template type.

Values:

  • 0 - Email template
  • 1 - Other types
Example:

0

​
thumbnail
string | null

URL to template thumbnail image

Example:

"https://cdn.sendx.io/templates/thumb_abc123.png"

​
editorType
integer

Editor type used to create the template.

Values:

  • 0 - PlainText
  • 1 - DragDrop
  • 2 - SendxEditor
Example:

1

​
created
string<date-time>

Template creation timestamp

Example:

"2024-01-10T14:20:00Z"

​
updated
string<date-time>

Template last update timestamp

Example:

"2024-01-15T09:15:00Z"

⌘I