Skip to main content
POST
Generate Campaign Variations
Starts generating 1 to 4 variations with AI and returns them at once with status: "generating". Each one takes its own direction, planned from your prompt, so the versions differ from each other. style sets how far they move: close versions are edits of the source; fresh versions are written anew from its content, each with its own structure in your brand’s colors and fonts; bold versions also get their own look (a theme of their own). The campaign email does not change. Generation runs in the background and usually takes under a minute. Poll List Variations or Get Variation until each one is ready or failed. Each variation succeeds or fails on its own; a failed one has an error and no blocks. A variation still generating after 10 minutes is reported as failed. Retrying is a new request: it creates new variations rather than resuming failed ones. The source is the email’s saved content, or the variation in parentVariationId, which must be ready. An email that is a single raw HTML block can’t be varied: convert it to Sequenzy blocks first (the editor hides its Canvas tab for HTML emails too). To make the new versions stay close to a version you liked, pass it as parentVariationId (they default to style: "close"); pass style: "bold" for something completely different.

Request

string
required
Campaign ID. Email campaigns only.
string
required
The direction for the new versions, in any language. Up to 2,000 characters. Name specific versions (“one formal, one playful”) to get exactly those.
integer
default:"3"
How many variations to generate, from 1 to 4.
string | null
Derive from this variation instead of the email. The new variations are its branches.
string
How far the new versions move from the source: close edits it, keeping its style and structure; fresh writes each version anew with its own structure in your brand’s colors and fonts; bold also gives each its own look (a theme of its own). Defaults to close for branches of a variation and fresh otherwise.

Response

Returns 202 Accepted.
array
The new variations, all with status: "generating" and blocks: null.
When the email is empty, each variation is a complete first draft, ending with your company’s default footer if you have one. Variations change content (blocks, subject and preview text), not the email’s theme. A 409 also means the email already has variations generating and this request would take it past 8 at once. Wait for some to finish (poll List variations), then send the request again. A 503 means generation could not be started. Any variations it created are marked failed; send the request again.