Skip to content

Clone Template

POST
/newsletters/templates/clone

Import an existing email as a template.

source decides which of url, issue_id and html is read - the other two are ignored rather than rejected, so sending all three is not an error and not a merge.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Import an existing email as a template.

source says which of the three optional inputs is the real one: url reads url, past_issue reads issue_id, html reads html. It is deliberately left an open string rather than a Literal, because the app leaves it open - closing it here would 422 a source the app added.

object
html
Any of:
string
issue_id
Any of:
string
keep_images

Keep the original images rather than dropping them.

boolean
reskin

Restyle the import to the org’s brand.

boolean
default: true
source
required

url, past_issue or html.

string
url
Any of:
string

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