References

List email references

Changed on

Lists real emails (and, for sequences, whole sequences) 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, ranked by how close their businesses (what each sells, and to whom) are in meaning to your company description, closest first (rankings are reused for up to 10 minutes; a description change counts at once). Each url works with the from-example endpoints. Always empty when the gallery is not available. Requires templates:read.

get/references

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/references
  • Auth
    HTTP bearer

Query parameters

kind'campaign' | 'sequence' | 'transactional' required
scope'similar' | 'all'

similar (default) lists emails from the gallery brands most like you; all lists the whole gallery for the kind, a page at a time.

qstring

Search words matched by meaning, most relevant first. With scope=similar only those brands' emails are searched. A search is paged.

pageinteger

Page for scope=all or a search.

subtypestring

For scope=similar without q, a gallery subtype to list first, such as password_reset. Ignored when it does not belong to the kind.

limitinteger

For scope=similar without q, most emails (and sequences) to return. Also caps sequences elsewhere.

Response

References

successboolean
kind'campaign' | 'sequence' | 'transactional'
scope'similar' | 'all'
pageinteger
pageCountinteger
profile'ready' | 'missing'

missing when your company has neither a description nor company context to find brands like you; scope=similar is then empty. Always ready for scope=all.

Example response

{
  "success": true
}

Changes