Categories
Every template has a category. Supported values are:otpwelcomereceiptalertnotificationcustom
category is required when creating a template and can be changed when updating one.
Template content
A template can include:nameand optionalaliascategory- sender fields such as
fromandreply_to subjecthtmland optionaltext- typed variables with optional fallback values
string and number.
Versions and publishing
Templates keep versions so content can evolve without losing previous definitions. You can list versions, retrieve a specific version, publish the current template, and revert to an earlier version. Publishing is a template lifecycle operation. It is not part of the broadcast send path.Preview and test send
Preview a template with variable values before using it in an application workflow. You can also issue a test send to a specific recipient without creating a broadcast.Pagination
BothGET /templates and GET /templates/{template}/versions use limit and offset pagination.
limitdefaults to50when omitted or non-positive.- Values above
100are capped at100by the HTTP handler. offsetdefaults to0, and negative values are treated as0.- Malformed integer values for
limitoroffsetreturn400 Bad Request.
GET /templates returns an object with data and has_more. The service requests one extra template internally to determine whether another page exists.
GET /templates/{template}/versions returns a plain array of versions and does not include has_more. For version history, advance offset by the number of versions returned and stop when a page contains fewer than the effective limit.
API Reference
Explore the template endpoints, request bodies, and responses.
Broadcasts
Learn how broadcast-owned content differs from reusable templates.