Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Emails::Template

Create Email Template

Create an email template from html_body/text_body. The template is marked api-created and is hidden from the visual template pickers (it cannot be edited in the visual BeeFree editor). When accessing the API through an OAuth connection from a third-party platform acting on another team's workspaces, this endpoint is restricted to trusted developer platforms; if you are using your own API key (acting on your own account), you can write directly.

post/workspaces/{workspace_id}/emails/templates

Path parameters

workspace_idinteger required

Request body

Example request

{
  "emails_template": {
    "emails_template": {
      "name": "Welcome Email",
      "subject": "Welcome aboard!",
      "html_body": "<h1>Hello</h1>",
      "text_body": "Hello",
      "from_address_id": 4001
    }
  }
}

Response

Created

idinteger

Template ID

public_idstring nullable

Template public ID

workspace_idinteger

Workspace ID

namestring nullable

Template name

template_typestring

Template type

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

subjectstring nullable

Default email subject line for the template

html_bodystring nullable

Expandable The template's rendered HTML body. Only returned when expand[]=html_body is provided. get_html is a per-template cloud-storage read, so this is omitted from list and show by default; expanding it on a list fans out to one read per row — use sparingly.

text_bodystring nullable

Expandable The template's plain text body. Only returned when expand[]=text_body is provided.

created_via_apiboolean

Whether this template was authored via the public API. API-created templates are hidden from the visual template pickers and cannot be edited in the visual (BeeFree) editor.

Example response

{
  "id": 1,
  "public_id": "MnOpQr",
  "workspace_id": 42000,
  "name": "Welcome Email",
  "template_type": "email",
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "subject": "Welcome aboard!",
  "html_body": "<h1>Hello</h1>",
  "text_body": "Hello",
  "created_via_api": true,
  "from_address": {
    "id": 4001,
    "public_id": "FrAd01",
    "email_address": "marketing@example.com",
    "name": "Marketing Team"
  }
}