Skip to content

Generate Newsletter Issue

POST
/newsletters/{newsletter_id}/issues/{issue_id}/generate

Generate the issue’s content with AI (runs a model; billable). Poll generation-status.

Authorizations

Parameters

Path Parameters

newsletter_id
required

Newsletter id.

string format: uuid

Newsletter id.

issue_id
required

Issue id.

integer

Issue id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
html_mode

email_safe: table layout, inline CSS. modern: div layout.

string
default: email_safe
Allowed values: email_safe modern
prompt
Any of:
string
template_id
Any of:
integer

Responses

200

Successful Response

object
data
required

An issue, version list, template, verification job or link result.

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