List of Standard Service Variables
In this article, you can find a list of standard service variables that exist in the Wooxy platform.
IMPORTANT: All variables should be in “lowerCamelCase” format. Only Latin letters are allowed. No underlines, special symbols, etc.
Please, while importing and creating variables, be sure to follow the format rules so that our system can recognize them:
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.
Use YYYY-MM-DD format for date values (example: {{contactBirthday}} variable with the value “1900-01-01”).
To get acquainted with the common mistakes that may be admitted during the file import read this article.
Global variables
For each Contact List, you can use variables that already exist or you can create custom ones. Global variables are universal and can be used for all Contact Lists. With these, you will be able to use messages with predefined values that are common to all subscribers. For example, the name and address of your company, or the current day, etc.
| Variable | Description and format requirements. |
| {{host}} | Website domain name in your “From Email” address. It is changing right after you switch the domain in the account. |
| {{unSubscribeUrl}} | Use this variable to provide your contacts a way to unsubscribe from the Contact List. Example: You may <a href=”{{unSubscribeUrl}}”>unsubscribe</a> from the upcoming emails. Result: You may unsubscribe from the upcoming emails. |
| {{subscribeUrl}} | You can use this variable to provide your contacts a way to subscribe to the Contact List. Example: Want to join our weekly newsletter and get all the latest news? {{subscribeUrl}} Result: Want to join our weekly newsletter and get all the latest news? SUBSCRIBE (button with the subscribe link) |
| {{telegramBot_yourBotName}} | Use this variable to provide your users a link to subscribe to Telegram Bot linked with the Wooxy platform. Example: Press here (link to your telegram bot) to subscribe to our Telegram Bot “{{telegramBot_yourBotName}}” to get additional bonuses. Result: Press here (link of the Telegram Bot) to subscribe to our Telegram Bot “Promo_Codes” to get additional bonuses. |
| {{currentDate}} | Current date in ENUM_DATE (MM-DD-YYYY) format. IMPORTANT: UTC Time Zone. Example: Welcome! You successfully registered on {{currentDate}} and deserve the present! Result: Welcome! You successfully registered on 02-27-2023 and deserve the present! |
| {{currentMonth}} | The current month. Example: It is the {{currentMonth}} month of the year so catch new bonuses! Result: It is the 02 month of the year so catch new bonuses! |
| {{currentYear}} | The current year. Example: Buy an upgrade to the next level in {{currentYear}} and get extra coins. Result: Buy an upgrade to the next level in 2023 and get extra coins. |
| {{campaignName}} | Campaign title. Example: You participated in the {{campaignName}} program, and we have a new offer for you. Result: You participated in the {{campaignName}} program, and we have a new offer for you. Also can be used in UTM parameters formation example.com/utm_campaign={{campaignName}} |
| {{workflowName}} | Workflow name. Example: Want to be a part of the workshop? Participate in our new project “{{workflowName}}”. Result: Want to be a part of the workshop? Participate in our new project “Synergy”. |
| {{listName}} | Displays the Contact List’s name. |
| {{segmentName}} | Displays the Segment’s name. |
| {{templateId}} | ID of the Template from your account. Can be used in UTM parameters formation |
Placeholdres
You can use placeholders in your templates. These placeholders are replaced with the relevant values after sending. These universal placeholders require no additional setup, and serve essential functions, such as adding unsubscribe links to your emails.
The placeholders may be used not only in templates but also in raw content for SMTP communication or in our API method, such as Send Email or Send Triggered Email.
| Variable | Description and format requirements. |
| {webVersion} | Use this variable to provide your contacts with a link to the web version of the message. It could be helpful when the ESP cannot fully render the Template you sent, so the recipient is able to view it in a browser window. Example: Not displaying correctly?<a href=”{webVersion}”>View in Browser</a> Result: Not displaying correctly? View in Browser (by pressing this link the contact will be redirected to another tab with the web version of the Template). |
| {listUnsubscribeLink} | Use this variable to give your contacts an option to unsubscribe using the list-unsubscribe mechanism. Important! Contacts who unsubscribe from your mailing list using this method are automatically added to the suppression list. Example: You may <a href=”{listUnsubscribeLink}}”>list-unsubscribe</a> from the upcoming emails. Result: You may list-unsubscribe from the upcoming emails. This variable works for all email-sending methods:
|
Variables for the contact subscribing
To receive communication from you, your users should be subscribed to the specific channel in your Contact List, otherwise, they will be ignored during bulk Campaigns and by Automations sending. Learn how to subscribe contact in our article.
| Variable | Description and format requirements. |
| {{active}} | Used to specify if a contact is subscribed or unsubscribed from the Contact List. Use value “1” to subscribe user and value “0” to unsubscribe. The default value is false (disable). |
| {{emailSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Email channel. Use value “1” to subscribe user and value “0” to unsubscribe. The default value is false (disable). |
| {{smsSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the SMS channel. Use value “1” to subscribe user and value “0” to unsubscribe. The default value is false (disable). |
| {{desktopWebPushSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Desktop Web Push channel. Use value “1” to subscribe user and value “0” to unsubscribe. The default value is false (disable). |
| {{mobileWebPushSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Mobile Web Push channel. Use value “1” to subscribe user and value “0” to unsubscribe. The default value is false (disable). |
| {{telegramSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Telegram channel. Use value “1” to subscribe user and value “0” to unsubscribe. The default value is false (disable). |
| {{viberSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Viber channel. Use value “1” to subscribe user and value “0” to unsubscribe. The default value is false (disable). |
Variables for Templates
Make the customer feel important and special with content personalization. Use the variables from the list below in the Template to generate unique content for each individual user. The dynamic content will let your customers feel closer to you and sow strong partnerships. See how to implement the dynamic content in our article.
| Variable | Description and format requirements. | |
| {{name}} | The optional display name to use for the recipient. It is also used as “Send to Name” in emails. When you add a contact for the first time with firstName and lastName variables, both values are merging and are written in the {{name}} variable. You can edit the {{name}} variable at any time. | |
| {{firstName}} | Contact’s first name. | |
| {{lastName}} | Contact’s last name. | |
| {{email}} | The email address of the contact. You must include an “email” column in your import file if you want this parameter to be displayed for your contacts. 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}} | Contact phone number. Should be a valid E.164 phone number. You must include the “phoneNumber” column in your import file if you want this parameter to be displayed for your contacts. Only one phone number for each contact. | |
| {{userId}} | The user id from the customer’s platform to be able to manipulate lists based on it. Used as an alliance for the email address. You must include an “userId” column in your import file if you want this parameter to be displayed for your contacts. Only one user ID for each contact. | |
| {{active}} | Used to specify if a contact is subscribed or unsubscribed from the Contact List. This variable is helpful in the dynamic content creation in the Template. Use the twig language – with the help of its tools, you can create creative and functional Templates. The default value is false (disable). | |
| 1 | Contact enabled. Contact can receive communication from enabled channels. | |
| 0 | Contact disabled. No communications will be sent to this contact. | |
| {{contactBirthday}} | Contact’s birth date in ENUM_DATE (YYYY-MM-DD) format. | |
| {{contactLanguage}} | Contact’s locale in ISO 639-1 format. | |
| {{contactGender}} | Contact’s gender in ISO/IEC 5218 format. | |
| 0 | Not known | |
| 1 | Male | |
| 2 | Female | |
| 9 | Not applicable | |
| {{contactTimezone}} | Contact’s timezone in ISO 8601 format. | |
| {{contactScore}} | The Contact Score. It is a way to qualify leads and assess how valuable they are to your organization. | |
| {{avatarLink}} | Link to contact’s avatar image. | |
| {{facebookLink}} | Link to contact’s Facebook profile. | |
| {{instagramLink}} | Link to contact’s Instagram profile. | |
| {{linkedInLink}} | Link to contact’s LinkedIn profile. | |
| {{twitterLink}} | Link to contact’s Twitter profile. | |
| {{tiktokLink}} | Link to contact’s TikTok profile. | |
| {{sourceId}} | Customer Acquisition Source ID from Wooxy platform. Should be registered in the Source section in the Wooxy admin panel. | |
| {{customerSourceId}} | Customer Acquisition Source ID from your system to synchronize two sides. Should be registered in the Source section in the Wooxy admin panel. | |
| {{sourceName}} | Customer Acquisition Source Name from your system to synchronize two sides. Should be registered in the Source section in the Wooxy admin panel. | |
| {{CAC}} (Customer acquisition cost) | The total cost of acquiring a new customer. It should generally include things like: advertising costs, the salary of your marketers, the costs of your salespeople, etc., divided by the number of customers acquired. The CAC variable is created automatically in the Contact List right after you import these two variables: | |
| cacValue | Customer Acquisition Value in 'ENUM_STRING' format correspondingly. If not provided default value will be used from the registered Customer Acquisition Source. | |
| cacCurrency | 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. | |
| {{companyName}} | Company name linked to your Contact List. Use it, for example, in the footer of the Template. Example: {{companyName}}, 44 Montgomery Street, Suite 300, San Francisco, USA. Result: Monocompany LLC, 44 Montgomery Street, Suite 300, San Francisco, USA. | |
| {{companyEmail}} | Company email address linked to your Contact List. Example: Contact us via {{companyEmail}}. Result: Contact us via example@domain.com. | |
| {{companyAddress}} | Company physical address linked to your Contact List. Example: Monocompany LLC, {{companyAddress}}. Result: Monocompany LLC, 44 Montgomery Street, Suite 300, San Francisco, USA. | |
| {{companyCity}} | Company location city linked to your Contact List. Example: Monocompany LLC, 44 Montgomery Street, Suite 300, {{companyСity}}, USA. Result: Monocompany LLC, 44 Montgomery Street, Suite 300, San Francisco, USA. | |
| {{companyCountry}} | Company location country linked to your Contact List. Example: Monocompany LLC, 44 Montgomery Street, Suite 300, San Francisco, {{companyСountry}} Result: Monocompany LLC, 44 Montgomery Street, Suite 300, San Francisco, USA. | |
| {{host}} | Website domain name from your “From Email” address. | |
| {{listName}} | Displays the Contact List name. | |
| {{unSubscribeUrl}} | You can use this variable in the Template to provide your contacts a way to unsubscribe from the Contact List. | |
| {{subscribeUrl}} | You can use this variable in the Template to provide your contacts a way to subscribe to the Contact List. | |
| {{webVersionLink}} | You can use this variable in the Template to provide your contacts a link to the web version of the message. It could be helpful when the ESP cannot fully render the Template you sent, so the recipient is able to view it in a browser window. Example: Not displaying correctly?<a href=”{{webVersionLink}}”>View in Browser</a> Result: Not displaying correctly? View in Browser (by pressing this link the contact will be redirected to another tab with the web version of the Template). | |
| {{telegramBot_yourBotName}} | You can use this variable in the Template to provide your contacts a link to subscribe to Telegram Bot linked with the Wooxy platform. | |
| {{currentDate}} | Current date in ENUM_DATE (MM-DD-YYYY) format. IMPORTANT: UTC Time Zone. Example: Welcome! You successfully registered on {{currentDate}} and deserve the present! Result: Welcome! You successfully registered on 02-27-2023 and deserve the present! | |
| {{currentMonth}} | The current month. Example: It is the {{currentMonth}} month of the year so catch new bonuses! Result: It is the 02 month of the year so catch new bonuses! | |
| {{currentYear}} | The current year. Example: Buy an upgrade to the next level in {{currentYear}} and get extra coins. Result: Buy an upgrade to the next level in 2023 and get extra coins. | |
| {{campaignName}} | Campaign title. Example: You participated in the {{campaignName}} program, and we have a new offer for you. Result: You participated in the {{campaignName}} program, and we have a new offer for you. Also can be used in UTM parameters formation example.com/utm_campaign={{campaignName}} | |
| {{workflowName}} | Workflow name. Example: Want to be a part of the workshop? Participate in our new project “{{workflowName}}”. Result: Want to be a part of the workshop? Participate in our new project “Synergy”. | |
| {{segmentName}} | Displays the Segment’s name. | |
Contact List settings variables
Information about your company can be used in emails for personalization. For example, form a signature in the footer of the letter or introduce yourself on behalf of the company and congratulate on registration or offer pleasant bonuses.
| 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 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 are stored in Contact List
The Wooxy platform contains by default a list of the most commonly used variables. The value of each of them will help in personalizing the content, as well as segmenting the Audience.
| Variable | Description and format requirements. | |
| {{name}} | The optional display name to use for the recipient. It is also used as “Send to Name” in emails. When you add a contact for the first time with firstName and lastName variables, both values are merging and are written in the {{name}} variable. You can edit the {{name}} variable at any time. | |
| {{firstName}} | Contact’s first name. | |
| {{lastName}} | Contact’s last name. | |
| {{email}} | The email address of the contact. You must include an “email” column in your import file if you want this parameter to be displayed for your contacts. 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}} | Contact phone number. Should be a valid E.164 phone number. You must include the “phoneNumber” column in your import file if you want this parameter to be displayed for your contacts. Only one phone number for each contact. | |
| {{userId}} | The user id from the customer’s platform to be able to manipulate lists based on it. Used as an alliance for the email address. You must include an “userId” column in your import file if you want this parameter to be displayed for your contacts. Only one user ID for each contact. | |
| {{active}} | Used to specify if a contact is subscribed or unsubscribed from the Contact List. This variable is helpful in the dynamic content creation in the Template. Use the twig language – with the help of its tools, you can create creative and functional Templates. The default value is false (disable). | |
| 1 | Contact enabled. Contact can receive communication from enabled channels. | |
| 0 | Contact disabled. No communications will be sent to this contact. | |
| {{emailSubscribe}} | Used to specify if the contact is subscribed or unsubscribed to the Email channel. The default value is false (unsubscribed). | |
| 1 | Subscribe contact to emails. | |
| 0 | Unsubscribe contact from emails. | |
| {{smsSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the SMS channel. The default value is false (unsubscribed). | |
| 1 | Subscribe contact to SMS. | |
| 0 | Unsubscribe contact from SMS. | |
| {{desktopWebPushSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Desktop Web Push channel. The default value is false (unsubscribed). | |
| 1 | Subscribe contact to Desktop Web Push notifications. | |
| 0 | Unsubscribe contact from Desktop Web Push notifications. | |
| {{mobileWebPushSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Mobile Web Push channel. The default value is false (unsubscribed). | |
| 1 | Subscribe contact to Mobile Web Push notifications. | |
| 0 | Unsubscribe contact from Mobile Web Push notification. | |
| {{telegramSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Telegram channel. The default value is false (unsubscribed). | |
| 1 | Subscribe contact to Telegram messages. | |
| 0 | Unsubscribe contact from Telegram messages. | |
| {{viberSubscribe}} | Used to specify if a contact is subscribed or unsubscribed to the Viber channel. The default value is false (unsubscribed). | |
| 1 | Subscribe contact to Viber messages. | |
| 0 | Unsubscribe contact from Viber messages. | |
| {{contactBirthday}} | Contact’s birth date in ENUM_DATE (YYYY-MM-DD) format. | |
| {{contactLanguage}} | Contact’s locale in ISO 639-1 format. | |
| {{contactGender}} | Contact’s gender in ISO/IEC 5218 format. | |
| 0 | Not known | |
| 1 | Male | |
| 2 | Female | |
| 9 | Not applicable | |
| {{contactTimezone}} | Contact’s timezone in ISO 8601 format. | |
| {{contactScore}} | Contact Score. | |
| {{avatarLink}} | Link to contact’s avatar image. | |
| {{facebookLink}} | Link to contact’s Facebook profile. | |
| {{instagramLink}} | Link to contact’s Instagram profile. | |
| {{linkedInLink}} | Link to contact’s LinkedIn profile. | |
| {{twitterLink}} | Link to contact’s Twitter profile. | |
| {{tiktokLink}} | Link to contact’s TikTok profile. | |
| {{sourceId}} | Customer Acquisition Source ID from Wooxy platform. Should be registered in the Source section in the Wooxy admin panel. | |
| {{customerSourceId}} | Customer Acquisition Source ID from your system to synchronize two sides. Should be registered in the Source section in the Wooxy admin panel. | |
| {{sourceName}} | Customer Acquisition Source Name from your system to synchronize two sides. Should be registered in the Source section in the Wooxy admin panel. | |
| {{CAC}} (Customer acquisition cost) | The total cost of acquiring a new customer. It should generally include things like: advertising costs, the salary of your marketers, the costs of your salespeople, etc., divided by the number of customers acquired. The CAC variable is created automatically in the Contact List right after you import these two variables: | |
| cacValue | Customer Acquisition Value in 'ENUM_STRING' format correspondingly. If not provided default value will be used from the registered Customer Acquisition Source. | |
| cacCurrency | 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. | |
Create custom variables
You can create your own variables that may be useful for your business needs. Please follow the creation rules so that our system can recognize them correctly.
| Type | Description |
| customStringVariable | For the new Variable creation use only Latin letters in lowerCamelCase format, no numbers or other symbols are allowed. For value, no specific format is required. lowerCamelCase 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. |
| customDateVariable | For the new Variable creation use only Latin letters in lowerCamelCase format, no numbers or other symbols are allowed. For value, the ISO Standard year-month-day format (YYYY-MM-DD) is required. |
