Below you can find a list of standard service variables that you can use when creating email templates and sending campaigns.
IMPORTANT: All variables should be in “lowerCamelCase” format. Only Latin letters are allowed. No underlines, special symbols, etc.
- lowerCamelCase (part of CamelCase) is a naming convention in which a name is formed of multiple words that are joined together as a single word with the first letter of each of the multiple words (except the first one) capitalized within the new word that forms the name.
Note Use YYYY-MM-DD format for date values (example: “userBirthDate” => “1900-01-01”)
Global variables
| Variable | Description and format requirements. |
| {{host}} | Website domain name from your From_email address |
| {{unSubscribeUrl}} | You can use this variable in the template to provide your users a way to unsubscribe from the contact list |
| {{subscribeUrl}} | You can use this variable in the template to provide your users a way to subscribe to the contact list |
| {{webVersionLink}} | You can use this variable in the template to provide your users a link to the web version of the message |
| {{telegramBot_yourBotName}} | You can use this variable in the template to provide your users a link to subscribed to Telegram Bot linked with SmartSender |
| {{currentDate}} | Current date in ENUM_DATE (YYYY-MM-DD) format. IMPORTANT UTC Time Zone |
| {{currentMonth}} | The current month |
| {{currentYear}} | The current year |
| {{campaignName}} | Campaign title |
| {{workflowName}} | Workflow name |
| {{listName}} | Displays the contact list name |
| {{segmentName}} | Displays the segment name. Doesn’t work with triggers and drip campaigns. |
Contact list settings variables
| Variable | Description and format requirements. |
| {{companyName}} | Company name linked to your contact list |
| {{companyEmail}} | Company email address linked to your contact list |
| {{companyPhone}} | Company phone number address linked to your contact list |
| {{companyAddress}} | Company physical address linked to your contact list |
| {{companyCity}} | Company location city linked to your contact list |
| {{companyCountry}} | Company location country linked to your contact list |
| {{host}} | Website domain name from your From_email address |
| {{listName}} | Displays the contact list name |
Contact variables stored in contact list
| Variable | Description and format requirements. | |
|---|---|---|
name'optional' |
The optional display name to use for the recipient. Also used as From_name in emails. | |
email'optional' |
The new email address of the recipient. You must include an email address column in your import file and only one email for each contact. IMPORTANT Review this column for anything that might cause syntax errors, like missing information, unsupported characters, and extra spaces before or after an address. |
|
phoneNumber'optional' |
Addressee phone number. IMPORTANT should be valid E.164 phone number format. |
|
userId'optional' |
The userId from the customer’s platform which enables manipulation of contacts based on it. Used as an alliance for the email address. | |
active'optional' |
Used to specify whether the contact is subscribed or unsubscribed from the list. If the user is unsubscribed from the list, no communication will be sent to his/her contact regardless of the status of separate channels. The default value is false (disable). | |
1'optional' |
Contact enabled. Contact can receive communication from enabled channels. | |
0'default' |
Contact disabled. No communications will be sent to this contact. | |
emailSubscribe'optional' |
Used to specify if contact is subscribed or unsubscribed to the Email Channel. The default value is false (unsubscribed). |
|
1'optional' |
Subscribe contact to emails | |
0'default' |
Unsubscribe contact from emails | |
smsSubscribe'optional' |
Used to specify whether the contact is subscribed or unsubscribed to the SMS Channel. The default value is false (unsubscribed). |
|
1'optional' |
Subscribe contact to SMS | |
0'default' |
Unsubscribe contact from SMS | |
desktopWebPushSubscribe'optional' |
Used to specify whether the contact is subscribed or unsubscribed to the desktop Web Push Channel. The default value is false (unsubscribed). |
|
1'optional' |
Subscribe contact to desktop web push notifications | |
0'default' |
Unsubscribe contact from desktop web push notifications | |
mobileWebPushSubscribe'optional' |
Used to specify whether the contact is subscribed or unsubscribed to the mobile Web Push Channel. The default value is false (unsubscribed). |
|
1'optional' |
Subscribe contact to mobile web push notifications | |
0'default' |
Unsubscribe contact from mobile web push notification | |
telegramSubscribe'optional' |
Used to specify whether the contact is subscribed or unsubscribed to the Telegram Channel. The default value is false (unsubscribed). |
|
1'optional' |
Subscribe contact to Telegram messages | |
0'default' |
Unsubscribe contact from Telegram messages | |
firstName'optional' |
Contact’s first name | |
lastName'optional' |
Contact’s last name | |
contactBirthday'optional' |
Contact’s birth date in ENUM_DATE (YYYY-MM-DD) format |
|
contactLanguage'optional' |
Contact’s locale in ISO 639-1 format |
|
contactGender'optional' |
Contact’s gender in ISO/IEC 5218 format |
|
| 0 | Not known | |
| 1 | Male | |
| 2 | Female | |
| 9 | Not applicable | |
contactTimezone'optional' |
Contact’s timezone in ISO 8601 format |
|
contactScore'optional' |
Contact Score | |
avatarLink'optional' |
Link to contact’s avatar image. | |
facebookLink'optional' |
Link to contact’s Facebook profile. | |
instagramLink'optional' |
Link to contact’s Instagram profile. | |
linkedInLink'optional' |
Link to contact’s LinkedIn profile. | |
twitterLink'optional' |
Link to contact’s Twitter profile. | |
tiktokLink'optional' |
Link to contact’s TikTok profile. | |
sourceId'optional' |
Customer Acquisition Source ID from SmartSender platform. Should be registered in Source section at SmartSender admin panel. | |
customerSourceId'optional' |
Customer Acquisition Source ID from your system to synchronize two sides. Should be registered in Source section at SmartSender admin panel. | |
sourceName'optional' |
Customer Acquisition Source Name from your system to synchronize two sides. Should be registered in Source section at SmartSender admin panel. | |
cacValue'optional' |
Customer Acquisition Value in 'ENUM_STRING' format correspondingly. If not provided default value will be used from the registered Customer Acquisition Source. |
|
cacCurrency'optional' |
Customer Acquisition Currency: EUR or USD IMPORTANT Please use only Latin uppercase format. No numbers or other symbols allowed. If not provided default value will be used from the registered Customer Acquisition Source. |
|
| contactCreatedAt | The date of the contact creation. | |
customStringVariable'optional' |
Variable name in lowerCamelCase formatWARNING: Please use only Latin lowerCamelCase format. No numbers or other symbols allowed. String variable value in 'ENUM_STRING' |
|
customDateVariable'optional' |
For Variable, use only Latin in lowerCamelCase format, no numbers or other symbols are allowed. For date variable value 'ENUM_DATE' (YYYY-MM-DD) is 'required' |
|
