Skip to content

Create Newsletter

POST
/newsletters

Create a new newsletter (the parent container issues live under).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create a new newsletter. Mirrors CreateNewsletterRequest.

object
goal
Any of:
string
name
required
string
<= 255 characters

Responses

201

Successful Response

object
data
required

A single newsletter row. Open dict — mirrors _serialize_newsletter.

object
audience_list_id
Any of:
created_at
Any of:
string
goal
Any of:
string
id
Any of:
string
name
Any of:
string
slug
Any of:
string
status
Any of:
string
updated_at
Any of:
string
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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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