← API Index


Variable (v1)

A personalization variable: written as %alias% into a mail, SMS or content text, it is replaced by data of the addressed customer, an item, a date or a link when the text is used. Some aliases carry an id or amount argument, e.g. Artikel..Name - see the group's id_label.

# Field Type Description
0 key string language-independent key of the variable, e.g. customer.firstname
1 group string key of the variable group (see VariableGroup) this variable belongs to, e.g. customer
2 alias string the name to write between the percent signs, in the requested language, e.g. Vorname; parts mark an argument to fill in
3 description string what the variable is replaced with, in the requested language

Used in endpoints