Skip to main content
POST
/
businesses
/
{id}
/
email_templates
Create an email template
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/email_templates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "subject": "<string>",
  "body": "<string>",
  "attachments": [
    {
      "content": "<string>",
      "name": "<string>"
    }
  ],
  "one_off": true,
  "metadata": {},
  "kind": "plaintext"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "body": "<string>",
  "kind": "plaintext",
  "template_html": "<string>",
  "template_json": "<unknown>",
  "new_template_json": "<unknown>",
  "new_template_html": "<string>",
  "attachments": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "metadata": {},
  "created_at": "<string>",
  "enabled_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the business

Body

application/json
​
name
string
required

The name of the email template

​
subject
string
required

The subject of the email template. Variables are supported via {{ variableName }}

​
body
string
required

The plain text of the email. Mutually exclusive with rich text emails

​
attachments
object[]

An array of attachments that will always be sent with this template

​
one_off
boolean

Whether this is a one off email template

​
metadata
object

The metadata of the email template

​
kind
enum<string>

The kind of the email template

Available options:
plaintext

Response

200 - application/json

The created EmailTemplate object

​
id
string
required

The ID of the email template

​
name
string
required

The name of the email template

​
subject
string
required

The subject of the email template. Variables are supported via {{ variableName }}

​
body
string | null
required

The body of the email template. May be null. Variables are supported via {{ variableName }}

​
kind
enum<string>
required

The kind of the email template

Available options:
plaintext,
html,
unlayer,
old_editor,
editor
​
template_html
string | null
required

The HTML representation of the rich text email. May be null

​
template_json
any | null
required

The JSON representing the rich text email template. May be null

​
new_template_json
any | null
required

The new unlayer JSON template. May be null

​
new_template_html
string | null
required

The new unlayer HTML template. May be null

​
attachments
object[]
required

An array of attachments associated with the email template

​
metadata
object
required

Arbitrary metadata associated with this email template

​
created_at
string
required

The time when the email template was created in ISO 8601 format

​
enabled_at
string | null

The time when the email template was enabled in ISO 8601 format