POST
/
businesses
/
{id}
/
email_templates
/
ai
Create a new email template using AI
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/email_templates/ai \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "kind": "plaintext",
  "body": "<string>",
  "template_json": "<any>",
  "template_html": "<string>",
  "attachments": [
    {
      "content": "<string>",
      "name": "<string>"
    }
  ]
}
This endpoint can take a while to return an email template. Streaming responses coming soon

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
​
description
string
required

A description of the content that you'd like to include the email template

Response

200 - application/json

An EmailTemplate object generated by AI

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

​
kind
enum<string>
required

The kind of the email template

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

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

​
template_json
any
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