Skip to main content

AI Agent Variables Glossary

Introduction

Variables are placeholders you can add to AI Agent prompts and configurations to insert information dynamically when the agent runs. This can include business details, contact information, listing details, or the current date and time.

When you configure an agent, you may want it to include information specific to the person it is interacting with or the location it is working for, such as the customer's first name, the business phone number, or today's date.

An example. You write this in your agent:

Hi [Contact First Name], thanks for visiting [Business Name]. Book your next appointment here: [Business Appointment Link]

The customer receives:

Hi Maria, thanks for visiting Bright Smile Dental Studio. Book your next appointment here: https://www.brightsmiledental.com/book

How variables work

When configuring an AI Agent, you can insert variables into supported fields using the variable picker. The variable appears as a placeholder during agent configuration and is replaced with the corresponding value when the agent runs.

You don't need to remember these variable names. You can select them from the variable list while configuring the agent. They are grouped into four categories:

Category

What's in it

Business

Details about the location the agent is working for

Contact

Details about the person your agent is dealing with

Listings

Information about how the location appears across supported listing platforms.

Date and time

Today's date, time, month, and year

Before you start: four things to know

  1. Values are populated when the agent runs, not when you configure. While you're configuring, you'll see the placeholder. The corresponding value appears at the moment the agent runs.

  2. A variable may return a blank value when the corresponding information isn't available. Design prompts and messages so they still make sense when a variable is empty. For example, if a customer never provided their email address, the email variable comes back blank. Always write your message so it still reads well if a value is missing.

  3. Your account may have extra fields of its own. Your account may include custom contact or location fields in addition to the standard variables documented. Those appear in the same variable list, alongside the ones below.

  4. Sample values in this article are made up. They come from a fictional business (Bright Smile Dental Studio) to show you the shape of the value: a date, a phone number, a web link.

Business

Information about the location your agent is working on behalf of. For multi-location brands, these fill in with the details of the relevant location, so one agent works correctly for all of them.

Field

What it means

Example

Business Name

The name of the business or location.

Bright Smile Dental Studio

Business Alias

A shorter or alternative name for the location, if one has been set.

Bright Smile Dental

Business Address

The street address.

742 Elmwood Drive, Suite 105

Business City

The city.

Columbus

Business State

The state or province.

OH

Business Zip Code

The postal or ZIP code.

43201

Business Country

The country.

US

Business Phone Number

The main phone number.

+1 (614) 555-0184

Business Texting Number

The number used for sending and receiving texts. This is often different from the main phone number, so use this one when you're telling someone where to text.

+1 (614) 555-0185

Business Email

The main email address.

Business Category

The main industry or category the location belongs to.

Dentist

Business Subcategories

The additional categories the location falls under.

Cosmetic Dentistry, Pediatric Dentistry, Orthodontics

Business Website

The location's website.

Business Appointment Link

The page where customers can book an appointment.

Birdeye Microsite URL

The location's Birdeye page, which shows its reviews and details.

Google Profile URL

The location's Google Maps listing. Handy when asking someone to leave a Google review.

Facebook Profile URL

The location's Facebook page.

Instagram Profile URL

The location's Instagram profile.

Twitter Profile URL

The location's X (formerly Twitter) profile.

LinkedIn Profile URL

The location's LinkedIn company page.

YouTube Profile URL

The location's YouTube channel.

Business Android App URL

The location's app on the Google Play Store, if it has one.

Business iOS App URL

The location's app on the Apple App Store, if it has one.

Business Main Description

The main description of the location. This is the one to use when your agent needs to explain who the business is.

Bright Smile Dental Studio has been serving the Columbus community since 2009...

Birdeye Description

A short description shown on the location's Birdeye page.

Friendly neighborhood dental studio providing quality care for the whole family.

Business Services

The services the location offers.

Teeth Cleaning, Teeth Whitening, Dental Implants, Invisalign

Business Keywords

The search terms the location wants to be found for. Written for search engines, so they don't always read naturally in a sentence.

family dentist, teeth whitening, dental implants, braces

Business logo

A link to the location's logo image.

(an image link)

Contact

Information about the person the agent is interacting with, such as a customer, patient, lead, or guest.

Two things to keep in mind as you use these. The permission fields (the opt-ins, Unsubscribed, Blocked, and Can Be Contacted) reflect what this person has agreed to, so treat them as the deciding factor before your agent sends anything, and check the specific one that matches the message you're sending.

IMPORTANT:

AI Prediction variables are predictions based on available behavior data. Use them to guide agent decisions, but don't present their values to customers as factual information.

Field

What it means

Example

Contact First Name

The person's first name.

Maria

Contact Last Name

The person's last name.

Thompson

Contact Display Name

The person's full name, put together from their first and last name. Use this when you want the whole name in one go.

Maria Thompson

Contact Email

The person's email address.

Contact Phone

The person's phone number.

+1 (512) 867-5309

Contact Country Code

The country their phone number belongs to, as a two-letter code.

US

Contact Business ID

The ID number of the location this person is linked to.

1023

Contact State

Where this person sits in your customer journey: a lead you're still chasing, an existing customer, and so on.

customer

Contact Sentiment

How positive or negative this person has been overall, worked out automatically from their feedback.

positive

Contact Source

How did this person come into the system in the first place.

dashboard

Contact Referral Code

The unique code assigned to this person for referral programs.

MTHMP-X7K2

Last Activity Date

The last time this person did anything you have a record of.

2026-04-28T14:32:00Z

Email Engaged

Whether this person has engaged with your emails before. 1 means yes, 0 means no.

1

Can Be Contacted

The overall answer to "Are we allowed to reach out to this person?" 1 means yes, 0 means no.

1

Unsubscribed

Whether this person has unsubscribed. Note the direction: 0 means they are still subscribed; 1 means they have unsubscribed.

0

Blocked

Whether this person has been blocked.

false

Blocked On

The date and time they were blocked. Blank if they never were.

(blank)

SMS Enabled

Whether texting is switched on for this person. 1 means yes, 0 means no.

1

Phone and WhatsApp Number Same

Whether their phone number and WhatsApp number are the same number.

true

SMS Unsubscribe Date

The date when they unsubscribed from texts. Blank if they haven't.

(blank)

Email Unsubscribe Date

The date when they unsubscribed from emails. Blank if they haven't.

(blank)

SMS Feedback Opt-in

Agreed to receive review and feedback requests by text.

true

SMS Marketing Opt-in

Agreed to receive promotional texts.

false

SMS Service Opt-in

Agreed to receive service texts, such as appointment reminders and updates.

true

Email Feedback Opt-in

Agreed to receive review and feedback requests by email.

true

Email Marketing Opt-in

Agreed to receive promotional emails.

true

Email Service Opt-in

Agreed to receive service emails, such as appointment reminders and updates.

true

WhatsApp Opt-in

Agreed to be contacted on WhatsApp.

false

AI Prediction - Best Channel

The channel this person is most likely to respond on.

Email

AI Prediction - Best Time to Send

The time of day they're most likely to respond.

02:00 PM

AI Prediction - Best Day to Send

The day of the week they're most likely to respond.

Thursday

AI Prediction - Email Engagement Likelihood

How likely they are to open or click an email: Low, Medium, or High.

High

AI Prediction - SMS Engagement Likelihood

How likely they are to respond to a text: Low, Medium, or High.

Medium

AI Prediction - Review Submission Likelihood

How likely they are to actually leave a review if asked: Low, Medium, or High.

High

AI Prediction - Survey Participation Likelihood

How likely they are to complete a survey if asked: Low, Medium, or High.

Low

Listings

Information about how this location currently appears on major listing platforms.

Fields that start with GMB refer to the location's Google listing. GMB stands for Google My Business, now called GBP (Google Business Profile).

Field

What it means

Example

GMB Description

The "about the business" text on the Google listing.

Bright Smile Dental Studio offers comprehensive dental care...

GMB Google Phone

The phone number customers see on Google.

+1 (614) 555-0184

GMB Override Website URL

A different web address to show on Google instead of the main website. It's useful for sending Google visitors to a specific page.

GMB Primary Category Name

The location's main Google category, in words. This is the one you'd usually want to display.

Dentist

GMB Primary Category ID

Google's internal code for that same category. Only needed for troubleshooting.

dentist

GMB Store ID

The store code that identifies this location inside Google Business Profile. Useful for multi-location brands matching listings to internal records.

BSD-COL-001

Google Suggestions Pending Count

The number of edits Google has suggested for this listing that nobody has reviewed yet. A good trigger for a "someone needs to look at this" alert.

2

Google Suggestions Any Approved

Whether any Google-suggested edit has been accepted for this listing.

true

Facebook Description

The description on the Facebook page.

Your neighborhood dental studio in Columbus, OH.

Facebook Phone

The phone number shown on Facebook.

+1 (614) 555-0184

Facebook URL

The website address shown on the Facebook page.

Facebook Categories

The categories the location is listed under on Facebook.

Dentist & Dental Office

Facebook Override Category

Whether the Facebook category has been set separately instead of following the main business category.

false

Apple Brand Name

The brand name shown on the Apple Maps listing.

Bright Smile Dental Studio

Apple Phone Number

The phone number shown on Apple Maps.

+1 (614) 555-0184

Apple Supported More Hours

The extra types of hours Apple allows for this kind of business, such as pharmacy or drive-through hours.

Pharmacy Hours, Bakery Hours, Drive Through Hours

Apple Media Enabled

Whether photos and logos are being sent through to Apple Maps for this location. 1 means yes, 0 means no.

1

Apple Is Delegated

Whether management of this Apple Maps listing has been handed over so it can be updated on the business's behalf. 1 means yes, 0 means no.

1

Apple Company ID

Apple Maps' reference number for the overall brand. For support and troubleshooting.

APPL-CO-88234

Apple Business ID

Apple Maps' reference number for this specific location. For support and troubleshooting.

APPL-BIZ-44129

Yelp Description

The description on the Yelp page.

Bright Smile Dental Studio is a family-friendly dental practice...

Yelp Phone Number

The phone number shown on Yelp.

+1 (614) 555-0184

Yelp Website URL

The website address shown on Yelp.

Yelp Override Category

Whether the Yelp category has been set separately instead of following the main business category.

false

Vendor Primary Category Name

The main category used for the other directory sites this location is published to, in words.

Dentist

Vendor Primary Category ID

The internal code for that same category. Only needed for troubleshooting.

dentist

Vendor Override Category

Whether that category has been set separately instead of following the main business category.

false

Hours Info

The location's opening hours.

Monday 8:00 AM - 5:00 PM

Supported More Hours

The extra types of hours Google allows for this kind of business, such as breakfast, delivery, or takeout hours.

Breakfast, Lunch, Delivery, Takeout

Logo Status

Indicates the current publishing status of the logo. LIVE means the logo is currently published on the listing.

LIVE

Business Info Opt-out

Indicates whether the location has opted out of publishing its business information on listing sites. 1 = opted out; 0 = not opted out.

0

Healthcare Enabled

Whether healthcare-specific features are switched on for this location. 1 means yes, 0 means no.

0

Date and time

These variables are populated when the agent runs, so a message that says "as of [Current Date]" remains accurate regardless of when it is sent.

Field

What it means

Example

Current Date

Today's date, written year-month-day.

2026-04-24

Current Day of the Week

Today's day, spelled out.

Friday

Current Day

Today's date number, on its own.

24

Current Month

This month, spelled out.

April

Current Month Number

This month is a two-digit number.

04

Current Year

This year.

2026

Current Time

The current time, on a 24-hour clock.

14:30:00

Current Date and Time

Today's date and the current time together.

2026-04-24 14:30:00

Current Week Epoch

The start of this week (Monday at midnight) is written as a long computer-readable number. It's used for date comparisons behind the scenes; don't show it to a customer.

1776643200000

Current Month Epoch

The first of this month at midnight, written the same way. Also for behind-the-scenes comparisons only.

1775289600000

Did this answer your question?