Skip to content

Activate Newsletter

POST
/newsletters/{newsletter_id}/activate

Take a draft newsletter live. LAUNCH-CLASS.

Once active, the scheduler will send any issue whose scheduled time has passed - so this is not a metadata change, it is the switch that lets mail leave the building. Gated on campaigns:launch, the same permission the in-app route requires.

Authorizations

Parameters

Path Parameters

newsletter_id
required

Newsletter id (UUID).

string format: uuid

Newsletter id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

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