Sign in
Email Templates

Create email template

Creates an email template from a TipTap document. Requires a USER API key. Only Person and User variables are allowed.

post/public/v1/email-templates

Request body

namestring required
descriptionstring nullable
subjectstring required
bodyDocumentobject nullable

Example request

{
  "name": "example",
  "description": "example",
  "subject": "example"
}

Response

Template created

idnumber required
accountIdnumber required
namestring required
descriptionstring nullable required
subjectstring required
bodyDocumentobject nullable
bodyHtmlstring required
bodyTextstring required
contentHashstring required
documentSchemaVersionnumber required
rendererVersionnumber required
status'ACTIVE' | 'ARCHIVED' required
versionnumber required
archivedAtstring nullable required
createdAtstring nullable required
updatedAtstring nullable required

Example response

{
  "id": 1,
  "accountId": 1,
  "name": "example",
  "description": "example",
  "subject": "example",
  "bodyHtml": "example",
  "bodyText": "example",
  "contentHash": "example",
  "documentSchemaVersion": 1,
  "rendererVersion": 1,
  "status": "ACTIVE",
  "version": 1,
  "archivedAt": "example",
  "createdAt": "example",
  "updatedAt": "example",
  "createdBy": {
    "id": 1,
    "firstName": "example",
    "lastName": "example",
    "email": "user@example.com",
    "avatar": "example"
  },
  "updatedBy": {
    "id": 1,
    "firstName": "example",
    "lastName": "example",
    "email": "user@example.com",
    "avatar": "example"
  }
}

Changes

Changed in 1 of the 2 revisions of this API.1