Skip to content

Use Template

POST
/newsletters/templates/{template_id}/use

Turn a template into a new DRAFT issue on a newsletter.

A copy, not a link: editing the issue afterwards leaves the template alone, and editing the template does not reach back into issues already made from it.

Authorizations

Parameters

Path Parameters

template_id
required

Template id.

integer

Template id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Turn a template into a new draft issue on a newsletter.

object
newsletter_id
required

Which newsletter the draft issue is created on.

string format: uuid

Responses

201

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