Use macros in forms
A macro is a placeholder token (for example, GuestFirstName) that Zenoti replaces with a real value when the form opens. Macros let you personalize form content without retyping guest, service, or center details on every form. This article explains the macro catalog, how to insert a macro into a form field or content block, and which macros are available for each form type.
Note: Macros are not the same as dot phrases. Macros are resolved by the server before the form renders — the guest never sees the token. Dot phrases are text shortcuts that a provider types during form filling (for example,
.bpfor a blood pressure note).
On this page
- Before you begin
- Macro catalog
- Macro scope by form type
- Insert a macro into a form
- Troubleshooting
- Related articles
Before you begin
- You must be authoring a form in the form builder. Macros render in the legacy form builder too, but the insertion experience is optimized for the current form builder.
- Decide which macros you want to use. Not every macro is available on every form type — see Macro scope by form type below.
Permission: Edit under CustomFields in the Administrator section of the security role — Required to edit form definitions and insert macros.
Macro catalog
Macros are grouped by the data they reference.
Guest info
| Macro | Resolves to | Notes |
|---|---|---|
GuestFirstName |
First name | |
GuestLastName |
Last name | |
GuestCode |
Guest code | |
GuestAddress |
Street address | |
GuestAddress1 |
Alternative address line 1 | |
GuestAddress2 |
Alternative address line 2 | |
GuestCity |
Guest city | |
GuestState |
Guest state | |
GuestCountry |
Guest country | |
GuestPostalCode |
Postal / ZIP code | Also available as GuestZipCode (legacy alias) |
GuestEmailAddress |
||
GuestMobilePhone |
Mobile phone | |
GuestHomePhone |
Home phone | |
GuestWorkPhone |
Work phone | |
GuestDob |
Date of birth | |
GuestGender |
Gender | |
GuestReferral |
Referral code the guest can send | |
GuestReferredBy |
Referral source |
Center info
| Macro | Resolves to |
|---|---|
CenterName |
Center display name |
CenterCity |
Center city |
CenterState |
Center state |
CenterCountry |
Center country |
CenterZip |
Center ZIP code |
CenterPhone, CenterPhone2 |
Center phone numbers |
CenterAddress |
Street address |
CenterEmail |
Center email |
CenterAddlData1 |
Additional center data |
Organization
| Macro | Resolves to |
|---|---|
OrgName / CompanyName |
Organization display name |
Service info
| Macro | Resolves to | Notes |
|---|---|---|
ServiceName |
Service name | |
ServiceDate |
Date of the service | Also available as AppointmentDate (legacy alias) |
ServiceStartTime |
Start time | Also available as AppointmentStarttime (legacy alias) |
ServiceEndTime |
End time | Also available as AppointmentEndtime (legacy alias) |
ServiceDuration |
Duration | |
ServiceCost |
Service cost | |
TherapistName |
Assigned provider |
Package info
| Macro | Resolves to |
|---|---|
PackageName |
Package name |
PackageType |
Package type (Day, Promotional, Series, or Custom) |
PackageInvoiceNumber |
Package invoice number |
PackageValidFrom, PackageValidTill |
Validity window |
PackageSoldBy |
Employee who sold the package |
PackageSoldByEmployeeJobTitle |
Job title of the employee who sold the package |
PackagePrice |
Price |
PackagePaymentMethod |
Payment method |
PackageCountofScheduledPayments |
Scheduled payment count |
PackageFirstScheduledPaymentDate, PackageNextScheduledPaymentDate, PackageLastScheduledPaymentDate |
Payment schedule dates |
PackageTherapistName, PackageTherapistPhone |
Provider assigned via the package |
CancelledOn, TerminatedOn |
Lifecycle dates |
CompanyName |
Company name set at the center level |
NamesOfAllPackagesInTheInvoice |
Names of all packages sold on this invoice |
CategoryOfAllPackagesInTheInvoice |
Category of each package sold on this invoice |
QuantityOfEachPackageSoldInTheInvoice |
Quantity of each package sold on this invoice |
NameAndTypeOfAllItemsInInvoice |
All items on the invoice including services, packages, products, and memberships |
FirstInstallment |
Amount set for the first installment |
TotalDueMinusFirstInstallment |
Amount due after the first installment |
ScheduleOfPayments |
Full schedule of payment dates and amounts |
CardType |
Type of card used (for example, Mastercard or Visa) |
LastFourDigitsOfCard |
Last four digits of the card used |
BillingZipCode |
ZIP code linked to the billing card |
Membership info
Core membership macros
| Macro | Resolves to |
|---|---|
MembershipName |
Membership name |
RecMembershipName |
Recurring membership name (on the invoice) |
MembershipNumber |
Membership number |
MembershipType |
Type (Recurring, Non-recurring, Service Credits, Credit Value, or Discounts Only) |
MembershipDuration |
Duration |
MembershipValidFrom |
Start date |
MembershipValidTill |
End date |
MembershipSoldBy |
Employee who sold it |
MembershipSoldAt |
Center that sold the membership |
MembershipPrice |
Total membership price (authoring value) |
MembershipBasePrice |
Base membership price (pre-discount) |
MembershipTotalPrice |
Post-discount total |
MembershipInvoiceNo |
Invoice number |
MembershipFreezeAvailable |
Remaining freezes available |
MembershipFreezeUsed |
Freezes consumed |
MembershipSaleRepName |
Sales rep named on the sale |
MembershipSaleRepCenter |
Sales rep's center |
SetupFee |
Setup fee |
RecurringFee |
Recurring fee |
MemRenewalPrice |
Renewal price |
MemBalance |
Total credit balance remaining |
MembershipLockin |
Lock-in period (duration from start to end of lock-in cycles) |
MembershipExpiry |
Expiry date as set in membership settings |
MemExpiryDate |
Date by which the membership expires |
TodaysDate |
Current date |
Recurring membership pricing macros
| Macro | Resolves to |
|---|---|
RecMemAnnualFee |
Annual fee of the recurring membership |
RecMemAnnualFeeDiscount |
Discount applied to the annual fee |
RecMemSaleDiscount |
Discount applied to the membership sale price |
RecMemFinalSalePrice |
Final sale price after discount |
RecMemAnnualFeeFinalSalePrice |
Final annual fee after discount |
RecMemSetupFeeDiscount |
Discount applied to the setup fee |
RecMemSetupFeeFinalPrice |
Final setup fee after discount and taxes |
RecMemSalePrice |
Prorated sale fees before discount |
RecMemListPrice |
List price before tax and discount |
RecMemFinalListFee |
List price after tax and discount |
Payment and billing macros
| Macro | Resolves to |
|---|---|
Mem#OfCollections |
Total number of payment collections |
MemPaymentMethod |
Payment method used for membership fees |
MemFirstCollectionDate |
Date of the first payment collection |
MemNextCollectionDate |
Date of the next payment collection (resolves only after the initial payment is complete and the invoice is closed) |
RecurringMemFeeDueDate |
Due date for the next recurring fee |
RecMemAnnualFeeDueDate |
Due date for the next annual fee |
RecurringMemFeeSecondDueDate |
Due date for the second upcoming recurring payment |
RecMembershipSaleDate |
Date the recurring membership was sold |
RecMemSetupFeeCollectionDate |
Date the setup fee was collected |
MembershipFeeDiscountPeriod |
Duration for which the fee discount applies |
RecMemAnnualFeeDiscountPeriod |
Duration for which the annual fee discount applies |
DefaultPaymentDetails |
Default payment mode used at POS during sale |
DDPaymentDetails |
Direct debit details |
BackupPaymentDetails |
Backup payment method details |
DeclineFee |
Fee charged for failed/declined transactions |
Lifecycle event macros
| Macro | Resolves to |
|---|---|
ActionType |
The membership action triggering this form (e.g. Signup, Cancellation) |
FreezeFrom |
Date the membership freeze starts |
UnfreezeOn |
Date the membership freeze ends |
CancelOn |
Scheduled cancellation date |
TerminateOn |
Termination date |
GracePeriodEndsOn |
Date the grace period ends |
UpgradeDowngradeDate |
Date of the upgrade or downgrade action |
UpgradeDowngradeTo |
Membership being upgraded or downgraded to |
UpgradeDowngradePrice |
Price of the new membership |
UpgradeDowngradeAnnualFeePrice |
Annual fee of the new membership |
UpgradeDowngradePaymentMethod |
Payment method for the upgrade/downgrade |
UpgradeDowngradeBy |
Employee who performed the upgrade/downgrade |
UpgradeDowngradeProratedAmount |
Prorated amount for the upgrade/downgrade |
TransferOn |
Date of the membership transfer |
TransferTo |
Guest or center the membership was transferred to |
TransferBy |
Employee who performed the transfer |
TransferFrom |
Source guest or center |
Guest demographic macros (membership context)
| Macro | Resolves to |
|---|---|
GuestAge |
Guest's age |
Minor |
Whether the guest is a minor (Yes or No) |
(Invoice and payment macros also resolve when used inside a membership form.)
Note: This table is the membership-macro catalog for Forms. Any other Forms article that lists membership macros refers back to this list rather than maintaining a parallel copy.
Invoice info
| Macro | Resolves to |
|---|---|
InvoiceStatus |
Status of the invoice at the time of form filling |
InvoiceID, InvoiceNumber |
Invoice identifiers |
InvoiceCreationDate |
Creation date |
FirstInstallment, TotalDueMinusFirstInstallment |
Payment amounts |
ScheduleOfPayments |
Payment schedule |
CardType, LastFourDigitsOfCard |
Payment method |
BillingZipCode |
Billing ZIP |
Entity attributes
| Macro | Resolves to |
|---|---|
EntityCustomAttribute5 through EntityCustomAttribute14 |
The 10 entity-level custom attributes |
Custom macros
Ten custom macro slots — CustomMacro1 through CustomMacro10 — are available for carrying organization- or center-specific messages in appointment and form-related notifications. Their primary purpose is to communicate custom information to guests, such as location-specific instructions, promotional text, or policy reminders that vary by center.
The value each slot resolves to is configurable at the organization level, with the option to override individual slots at the center level. When both an organization value and a center value exist for the same slot, the center value takes precedence.
The following table summarizes the ten slots:
| Macro | Resolves to |
|---|---|
CustomMacro1 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro2 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro3 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro4 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro5 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro6 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro7 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro8 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro9 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
CustomMacro10 |
Organization- or center-configurable text (center value overrides organization value when both exist) |
All ten slots are optional. Slots that have no configured value resolve to an empty string in the rendered form or notification.
To configure custom macro text, navigate to Configuration > Forms and locate the custom macro settings. Center-level administrators can set center-specific overrides from the center's own settings page.
Tip: Custom macros are also available as selectable tokens in the form builder macro picker alongside all other macro categories. Form designers can insert them directly into form content — for example, to include a center-specific welcome message or policy notice inside a consent block.
Note: There are exactly ten custom macro slots. It is not possible to add additional slots beyond
CustomMacro10.
Macro scope by form type
| Form type | Macro categories available |
|---|---|
| Service form | Guest, Center, Organization, Service, Custom |
| Tag form | Guest, Center, Organization, Service, Custom |
| Guest form | Guest, Center, Organization, Custom |
| Membership form | Guest, Center, Organization, Membership, Invoice, Custom |
| Package form | Guest, Center, Organization, Package, Invoice, Custom |
| Entity form | Entity attributes, Center, Organization |
| Loyalty form | Guest, Center, Organization, Custom |
| Class form | Guest, Center, Organization, Service (class), Custom |
| Employee Survey | None |
Insert a macro into a form
- Open the form in the form builder.
- Select the field or Content component where you want the macro to appear.
- In the field's rich-text editor, use the macro picker to insert the token. The token appears in the form as
{{GuestFirstName}}(or the equivalent for your target macro). - Save the form.
- Preview the form against a test appointment to confirm the macro resolves to the expected value.
Tip: Macros inside consent text read more naturally when wrapped by surrounding prose ("I,
{{GuestFirstName}} {{GuestLastName}}, consent to …") than when placed on their own line.
Troubleshooting
| Symptom | What to check |
|---|---|
Macro renders as a literal token (e.g., {{GuestFirstName}}) in the form |
The form type does not support that macro category, or the macro is misspelled. Check the macro scope table. |
| Macro resolves to an empty value | The underlying field is empty for this guest / service / invoice. For example, MembershipNumber is empty on a non-membership appointment. |
| Custom macro text is unexpected | Verify the center-level override. Center values win over organization values when both are configured. |
| A custom macro slot resolves to nothing | The slot has no configured value at either the organization or center level. Navigate to Configuration > Forms to add text for the relevant slot. |