Skip to main content
POST
Preview Template from Example
Rewrite a public email from the Sequenzy email gallery and get it back without saving anything. It is the same rewrite as Create Template from Example: the example’s layout and design, every word written for your brand, and your logo, brand color and links swapped in. By default the preview is written for your company’s brand profile. Pass website to write it for another site instead, such as a prospect or a client. The site is looked up like the public gallery’s See it for your brand preview. Generation usually takes 5 to 20 seconds. Each call writes a new version. To keep one, call Create Template from Example; it writes the email again for your own brand. Requires the templates:write scope.

Request

Identify the example with url, or with brand and email. Sending both returns 400.
string
Gallery email page URL, such as https://sequenzy.com/email-examples/brands/linear/emails/welcome-to-linear, or a sequence page URL ending in #email-{email} for an email in a sequence. A sequence URL without an email returns 400; use Preview Sequence from Example for sequences.
string
Gallery brand slug, from /email-examples/brands/{brand}/.... Use with email.
string
Gallery email slug, from /emails/{email}. Use with brand.
string
Optional direction, up to 1000 characters. It takes priority over the example.
string
Optional site or domain, such as acme.com, to write the preview for instead of your own brand. Its registrable domain is used, so https://www.acme.com/pricing becomes acme.com. A value that is not a site returns 400.

Response

object
The unsaved rewrite: brandName (whose brand it is written in), website (the normalized website, or null for your own brand), subject, previewText and html.
object
The gallery example it is modeled on: brand, subject and url.
A 404 with code EMAIL_GALLERY_UNAVAILABLE means the email gallery is not available yet. A 503 with code REMIX_FAILED means the rewrite came back incomplete; retry. A 422 means a field failed validation, such as a brief over 1000 characters.