POST
/
businesses
/
{id}
/
email_templates
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>",
  "attachments": [
    {
      "content": "<string>",
      "name": "<string>"
    }
  ],
  "one_off": true,
  "metadata": {},
  "body": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "body": "<string>",
  "template_json": "<any>",
  "template_html": "<string>",
  "attachments": [
    {
      "content": "<string>",
      "name": "<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

​
template_json
enum<string> | null

Must be null or omitted

​
template_html
enum<string> | null

Must be null or omitted

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 }}

​
template_json
any | null
required

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

​
template_html
string | null
required

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

​
attachments
object[]
required

An array of attachment associted with the email template. Will be sent with every email built from this template