Skip to main content
POST
Create a template

Authorizations

Authorization
string
header
required

API token for authentication

Body

application/json
workspace_id
string
required

The ID of the workspace

Example:

"ws_1234567890"

id
string
required

Unique identifier for the template (alphanumeric, underscores, and hyphens only)

Maximum string length: 32
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"welcome_email"

name
string
required

Name of the template

Maximum string length: 32
Example:

"Welcome Email"

channel
enum<string>
required

Communication channel

Available options:
email,
web
Example:

"email"

category
enum<string>
required

Template category

Available options:
marketing,
transactional,
welcome,
opt_in,
unsubscribe,
bounce,
blocklist,
blog,
other
Example:

"transactional"

email
object
web
object
template_macro_id
string | null

ID of the template macro (layout) to use

test_data
object

Test data for template preview

settings
object

Channel-specific settings

Response

Template created successfully

template
object