Generate an email

The method allows the generation of an email template automatically with content received from an external data source using modules already saved to the Library. In this query, it is possible to operate the set of transformers that may filter or edit the received data in order to get the final actual version needed to be used in your mailings (e.g., use only today’s data or the data for women, etc.)

Body Params
dataSources
array of objects
required

Array of requested permissions

dataSources*
transformers
array of objects

Array of requested permissions

transformers
composers
array of objects

Array of requested permissions

composers
int64
required

An ID of a template with the auto-generated area. This template will be used for email generation. Please note that this template should be yours (saved in the project you have access to), not a basic or a public one.

int64

If you want to override an already existing email template, please specify its ID here. If this field is empty, then a new email will be created

string

This is the name that will be given to a generated email. If the field is empty, then the name of a template will be used as the name of the generated email

int64

This is the folder ID where the generated email will be stored

string

An email title

string

The email preheader

utm
object

UTM tracking parameters to apply to all links in the generated email. When regenerating an email (emailId provided), sending utm overwrites existing UTMs; omitting utm removes all UTM parameters from the email.

tags
array of strings

Names of the tags of the email. Not passed or empty — the email has no tags. When regenerating an email (emailId provided): passed — the email keeps only these tags; an empty list removes all its tags; not passed — its tags do not change. Each name is looked up among the email tags of the organization exactly, case included: an existing tag is set as it is; a name the organization has no tag of creates the tag, the same way as in the email details in Stripo, without a category. A new tag name is up to 30 characters: letters, digits, _ and -. Up to 20 tags per email; repeated names count once. The tags are set on the email, not on its language versions.

tags
Headers
string

Authentication token

Responses

400

A tag cannot be set: more than 20 tags, or a new tag name that breaks the rules (up to 30 characters: letters, digits, _ and -). The message names the tags; the email is not created or changed.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json