Campaigns
List Campaign Variations
List the alternative versions of a campaign email
GET
List Campaign Variations
Variations are alternative versions of a campaign’s email that you compare side by side on the editor’s Canvas tab. The campaign keeps sending its email until you use a variation.
This lists the campaign’s variations, oldest first. Discarded variations are not listed. While a variation is generating, poll this endpoint (or Get Variation) until its
status is ready or failed.
Request
string
required
Campaign ID. Email campaigns only.
Response
array
The variations, oldest first.
The variation object
string
Variation ID.
string
Canvas label:
V1, V2, … for versions of the email, V2.1, V2.2, …
for branches of V2. Labels are never reused, even after a discard.string
Short name, such as the direction it was generated in.
string | null
What changed, in a sentence.
string | null
The request that generated it.
null for variations you saved yourself.string
generating, ready or failed. A variation still generating after 10
minutes is reported as failed.string | null
Why generation failed.
string | null
The nearest variation it descends from that has not been discarded.
null
when it was derived from the email.string | null
The subject this variation uses.
null keeps the email’s subject.string | null
The preview text this variation uses.
null keeps the email’s.string | null
How far it was asked to move from its source (
close, fresh or bold)
when AI generated it.array | null
The variation’s email blocks.
null while
generating or after a failure.object | null
The variation’s own email theme.
null means it uses the email’s theme.string | null
The variation’s own body font stack.
null means it uses the email’s font.object | null
Where the user placed it on the editor canvas, as
{ "x", "y" } in canvas
pixels. null means the canvas places it automatically.boolean
Whether using this variation would leave the campaign email unchanged: the
same blocks, and its own subject, preview text, theme and font when it has
them. When several variations match, only the one used most recently is in
use.
string | null
When this variation was last put in the campaign email, as an ISO 8601
timestamp.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.