Skip to main content
POST
Create a template

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Body

application/json
name
string
required
Minimum string length: 1
Example:

"Welcome Email"

subject
string
required
Minimum string length: 1
Example:

"Welcome to {{company}}"

html_content
string
Example:

"<h1>Welcome {{name}}</h1>"

text_content
string
Example:

"Welcome {{name}}"

variables
string[]
Example:
from_email
string<email>

Default from email address. Must match a verified domain.

from_name
string

Display name for the sender. Combined with from_email as 'Name ' when sending.

Example:

"Acme Inc"

reply_to
string<email>

Reply-To email address for template-based emails.

preview_text
string

Preview text (preheader) shown in email clients.

Example:

"Check out what's new..."

inbox_id
string<uuid>

Optional inbox ID. When provided, the inbox's name, from address, and reply-to address are used as defaults unless explicit values are given.

Example:

"123e4567-e89b-12d3-a456-426614174000"

tags
string[]

Tags for categorization. Lowercase, max 50 chars each, max 20 tags.

Example:

Response

Template created

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>
required
name
string
required
subject
string
required
html_content
string | null
required
text_content
string | null
required
variables
string[] | null
required
from_email
string | null
required
from_name
string | null
required
reply_to
string | null
required
preview_text
string | null
required
preview_html
string | null
required

Preview HTML content for AI agent review workflow

inbox_id
string<uuid> | null
required

Associated inbox ID for sender identity defaults

Example:

"123e4567-e89b-12d3-a456-426614174000"

tags
string[]
required

Tags for categorization.

Example:
created_by
string<uuid> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required