Skip to main content
POST
Create template

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
name
string
required

The template name.

content
object
required
type
enum<string>

The template type.

Available options:
html,
visual
transactionID
string<uuid>

References transaction containing uploaded attachment used in template as logo.

Response

200 - application/json

Successful response.

ID
string<uuid>

Unique object identifier.

licenseID
integer

Unique account identifier.

createdAt
string<date-time>

The time of creation.

createdBy
string<uuid>

The creator identifier.

createdByType
enum<string>

The creator type.

Available options:
agent,
client,
system
updatedAt
string<date-time>

The time of last modification.

updatedBy
string<uuid>

The modification author identifier.

name
string

The template name.

content
object
type
enum<string>

The template type.

Available options:
html,
visual
attachments
object[]

The attachment list. Currently only template logo is supported.