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.
Contact List Variables
Contact list variables are values from your contact list settings. You can set these values when you create or update a contact list. They can be useful for adding contact information to your templates.
| {{listName}} | Displays the Contact List’s name. | |
| {{host}} | Website domain name in your “From Email” address. It is changing right after you switch the domain in the account. Example: {{host}} - the domain of the company from which you are receiving communications. Result: wooxy.com - the domain of the company from which you are receiving communications. | |
| {{companyName}} | The name of your Company can be used, 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}} | The {{companyEmail}} variable takes the "Default from email" value from your Contact list settings + {{host}} variable also from your Contact list settings. Example: Contact us via {{companyEmail}}. Result: Contact us via example@domain.com. | |
| {{companyAddress}} | Your company's physical address. Note that the city and country of your company's location are stored as separate variables. Example: Monocompany LLC, {{companyAddress}}. Result: Monocompany LLC, 44 Montgomery Street, Suite 300, San Francisco, USA. | |
| {{companyCountry}} | Your company's geographic location, specifically the country. Example: Monocompany LLC, 44 Montgomery Street, Suite 300, San Francisco, {{companyСountry}} Result: Monocompany LLC, 44 Montgomery Street, Suite 300, San Francisco, USA. | |
Contact Variables
Contact variables allow you to access data related to a contact and display it in a message. They can be used for list segmentation or to create dynamic templates with Twig. Some variables have standard values, such as {{emailSubscribe}}. For certain variables, the input format is important.
| {{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 merged and are written in the {{name}} variable. You can edit the {{name}} variable at any time. You can specify the value of the variable {{name}} separately if needed. |
| {{firstName}} | Contact’s first name. |
| {{lastName}} | Contact’s last name. |
| {{fullName}} | The value of the variable {{fullName}} is created by combining the variables {{firstName}} and {{lastName}}. The value of the variable {{fullName}} is not saved in the system. |
| {{email}} | The email address of the contact. You may import only one email per contact—еach contact must be associated with a single, unique email address. It serves as one of the three unique identifiers for a contact. An email address is a crucial component for email communications - without a valid email address, the system cannot deliver messages to the contact. IMPORTANT: Review email addresses for anything that might cause syntax errors, like typos, 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. This is one of the three unique identifiers for a contact. Without a valid phone number, it is impossible to send SMS communication. |
| {{userId}} | Your platform-specific user ID. This unique identifier helps enable efficient list management and control, allowing for streamlined organization and segmentation of contact data, Web push notifications, etc. It can also be used as an alliance for the email address. To implement this feature, ensure your import file contains a "userId" column.. Only one user ID for each contact. This is one of the three unique identifiers for a contact. |
| {{active}} | The variable {{active}} represents the contact's activity status. If the contact is inactive, they will not receive any communications. It is 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 to create sophisticated and efficient Templates with its robust set of tools and features. The default value is 0 (disable). |
| 1 | |
| 0 | |
| {{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 | |
| 1 | |
| 2 | |
| 9 | |
| {{contactTimezone}} | Contact’s timezone in ISO 8601 format. The variable {{contactTimezone}} is responsible for sending campaigns according to time zones. If the contact has this variable, the communication will be sent according to their time zone; if the variable is not specified, the sending will occur according to your account's time zone. |
| {{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. |
| {{cacValue}} | The variable {{cacValue}} in 'ENUM_STRING' format shows your cost per contact. |
| {{cacCurrency}} | The variable {{cacCurrency}} has only two values and display the currency you used to acquire a new contact:
IMPORTANT Please use only Latin uppercase format. No numbers or other symbols are allowed. |
| {{contactCreatedAt}} | The date of the contact creation. |
| {{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 0 (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 0 (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 0 (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 0 (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 0 (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 0 (disable). |
Standard Service Variables
Standard service variables that you can use in your templates. Some of them may only be used in templates of their specific type (WebPush, Telegram, etc.). Additionally, there are restrictions on the use of certain variables in email channel templates for different types of sends.
| {{telegramBot_yourBotName}} | Use this variable to provide your users with link to subscribe to Telegram Bot connected to 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. Note: The variable {{telegramBot_yourBotName}} will only work in templates sent in the Telegram channel. |
| {{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}} | Displays the Campaign’s title. Example: You participated in the {{campaignName}} program, and we have a new offer for you. Result: You participated in the Synergy program, and we have a new offer for you. Note: The {{campaignName}} variable is specifically designed for and limited to templates utilized within Campaign communications. Also can be used in UTM parameters formation example.com/utm_campaign={{campaignName}} |
| {{workflowName}} | Displays the Workflow’s 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”. Note: The variable {{workflowName}} will only work in templates sent in Workflows. Also can be used in UTM parameters formation: |
| {{splitTestName}} | Displays the Split Test’s name. Example: Want to be a part of the workshop? Participate in our new project “{{splitTestName}}”. Result: Want to be a part of the workshop? Participate in our new project “Synergy”. Note: The variable {{splitTestName}} will only work in templates sent in A/B Tests. Also can be used in UTM parameters formation |
| {{segmentName}} | Displays the Segment’s name. Example: Want to be a part of the workshop? Participate in our new project “{{segmentName}}”. Result: Want to be a part of the workshop? Participate in our new project “Synergy”. Note: The variable {{segmentName}} will only work in templates sent in A/B Tests and Campaigns. Also can be used in UTM parameters formation |
| {{templateId}} | ID of the Template from your account. Can be used in UTM parameter formation |
Service Variables For Email
These are special variables created for email templates. They allow you to add subscription and unsubscription links to your templates. Contacts who unsubscribe or subscribe this way will simply be unsubscribed or subscribed to the email list. The value of the variable {{emailSubscribe}} becomes equal to 1 or 0, respectively. Contacts who unsubscribe this way are not added to the blacklist.
| {{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. |
Placeholders
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.
| {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=”{{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). This placeholder works for all email-sending methods:
|
| {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 placeholder works for all email-sending methods:
|
