Create Template From Prompt

POST

/newsletters/templates/custom

• Production
• QA

Build a template from a plain-language idea. ASYNC and AI-backed.

voice_reference_issue_ids points the model at past issues to imitate, which is the difference between generic copy and something that sounds like the organisation. Same polling contract as /templates/layout.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Build a template from a plain-language idea. ASYNC and AI-backed.

object

audience_id

Any of:

string

string

null

null

goal

What it is for, e.g. product.

string

default: product

idea

required

What the email should say, in plain words.

string

length

Any of:

string

string

null

null

tone

Any of:

string

string

null

null

variants

Any of:

integer

integer

null

null

voice_reference_issue_ids

Past issues to imitate the voice of.

Array<string>

Responses

202

Successful Response

object

data

required

An open envelope for a newsletter, an issue, a template or a send row.

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string