References
List Email References
Gallery emails from brands like yours, or the whole gallery, to model a new email on
GET
List Email References
List real emails from the Sequenzy email gallery to model a new email on, for the kind of email you are creating. By default they come from the gallery brands most like you: Sequenzy compares your company description with every brand’s emails by meaning, ranking each brand by its best-matching emails. Nothing is stored: a change to your description counts on the next request, and new gallery brands within 10 minutes. With
The lists are empty when the email gallery is not available, or with
scope=all, list the whole gallery for that kind of email instead. These are the examples in the Gallery tab of the dashboard’s new campaign, transactional and sequence pickers, with its Brands like yours and All examples switch.
Each email’s url works with Create Template from Example, and each sequence’s with Create Sequence from Example.
Requires the templates:read scope.
Request
string
required
campaign (promotions, newsletters and product updates), sequence
(lifecycle emails, plus whole sequences) or transactional.string
default:"similar"
similar: emails (and, for kind=sequence, whole sequences) from the 12
gallery brands most like you, closest first. all: the whole gallery for the
kind, newest first, 48 per page.string
Search words, up to 80 characters, matched by meaning, most relevant first.
With
scope=similar only those brands’ emails are searched. A search is paged
like scope=all.integer
default:"1"
Page for
scope=all or a search, from 1 to 200.string
For
scope=similar without q: a gallery subtype to list first, such as
password_reset or welcome. Ignored when it does not belong to the kind.integer
default:"24"
For
scope=similar without q: most emails to return, from 1 to 60. Also
caps how many sequences are returned.Response
boolean
Always
true on success.string
The requested
kind.string
similar or all.integer
This page.
scope=similar without a search is always one page.integer
How many pages there are, at most 200.
string
ready, or missing when your company has neither a description nor company
context to compare with gallery brands yet. scope=similar is then empty; add
a description in your dashboard settings, or use scope=all. Always ready
for scope=all, which does not use it.object[]
With
scope=similar, the gallery brands most like you, closest first: name,
domain, slug and their gallery url. Your own brand is never included.
Empty for scope=all.object[]
Gallery emails. With
scope=similar and no search: the asked-for subtype
first, then one email per brand in turn, closest brands first.object[]
For
kind=sequence on the first page only: whole gallery sequences with id,
name, emailCount, brand and url. With scope=similar, closest brands
first; with a search, the sequences of the best matches. Empty otherwise.scope=similar when your company has no description yet (profile is missing). With scope=similar and no q, every result is on page 1, so later pages are empty. A 503 with code REFERENCES_UNAVAILABLE means your description could not be compared with gallery brands right now; nothing changed, so retry shortly or use scope=all. A 422 means a parameter failed validation, such as an unknown kind or scope, or a limit over 60.