Skip to content

Create Template From Layout

POST
/newsletters/templates/layout

Build a template from a named layout archetype. ASYNC and AI-backed.

202 rather than 201: the row exists immediately but the copy inside it is still being generated. Poll GET /newsletters/templates/{template_id}/generation-status - a template read before that reports done is a half-written one.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Build a template from a named layout archetype. ASYNC and AI-backed.

object
archetype_key
required

Which layout to build from.

string
audience_id
Any of:
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:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string