POST
/
businesses
/
{id}
/
email_templates

Authorizations

Authorization
string
headerrequired

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

attachments
object[]

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

body
string
required

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

template_json
enum<string> | null

Must be null or omitted

template_html
enum<string> | null

Must be null or omitted

Response

200 - application/json
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

List all email templates for a businessCreate a new email template using AI