Contact Field Variables Cheat Sheet
Every standard and custom contact field is available as a Velocity variable. To see all fields available in your account, go to Settings → Additional fields.
You can insert a variable manually or use the personalization menu in the message editor — a UI shortcut that inserts the correct variable syntax for you.
The menu is available in all channels: Email, SMS, Mobile Push, Web Push, App Inbox. The variable syntax is the same across all of them.
Below are common examples of contact field variables and safe patterns you can use in messages.
Standard Contact Fields
| Field | Variable |
|---|---|
| First name | ${firstName} |
| Last name | ${lastName} |
| Full name | ${firstName}, ${lastName} |
${email} | |
| SMS | ${sms} |
| External customer ID | ${externalCustomerId} |
| Town | ${town} |
| Address | ${address} |
| Region | ${county} |
| Postcode | ${postcode} |
| Message name | ${messageName} |
Custom Field Examples
Custom fields follow the same syntax. The variable name matches the field name you defined in Settings → Additional fields.
| Field | Variable |
|---|---|
| Bonus balance | ${personal.bonus} |
| Promo code | ${personal.promocode} |
| Subscription status | ${subscription.status} |
| Last training date | ${last.training.date} |
| Manager name | ${manager.name} |
| Manager phone | ${manager.phone} |
Variable names in your account may differ depending on how your contact fields are named.
Safe Patterns
Use these patterns when a value may be missing:
${firstName}— insert a value$!{firstName}— show nothing if the value is missing${firstName|'there'}— show fallback text if the value is missing${personal.bonus|'0'}— show a default value
Examples:
Hello, ${firstName|'there'}!
You have ${personal.bonus|'0'} bonus points.
Your manager: ${manager.name|'our support team'}
Notes
- Field names are case-insensitive:
${firstName},${FIRSTNAME}, and${firstname}all work the same way. - Use
${variable}with curly braces when the variable is adjacent to other text to avoid ambiguity. - Contact field variables work the same way across all channels: Email, SMS, Mobile Push, Web Push, App Inbox.
- For event data and external sources, variable availability depends on the context. See Using Velocity in Messages and Using Velocity in Workflows.
Updated 6 days ago