Emails, Text Messages and Dynamic Content

Customize your communication like a pro using these tokens in your channels.

• Contact

  Token name	Token syntax
  Attribution	{contactfield=attribution}
  Attribution Date	{contactfield=attribution_date}
  Address Line 1	{contactfield=address1}
  Address Line 2	{contactfield=address2}
  Country	{contactfield=country}
  City	{contactfield=city}
  Company	{contactfield=company}
  Contact ID	{contactfield=id}
  Email	{contactfield=email}
  Facebook	{contactfield=facebook}
  Fax	{contactfield=fax}
  First Name	{contactfield=firstname}
  Foursquare	{contactfield=foursquare}
  Google+	{contactfield=googleplus}
  Instagram	{contactfield=instagram}
  IP Address	{contactfield=ipAddress}
  Last Name	{contactfield=lastname}
  LinkedIn	{contactfield=linkedin}
  Mobile Number	{contactfield=mobile}
  Phone Number	{contactfield=phone}
  Position	{contactfield=position}
  Skype	{contactfield=skype}
  State	{contactfield=state}
  Twitter	{contactfield=twitter}
  Title	{contactfield=title}
  Website	{contactfield=website}
  Zip Code	{contactfield=zipcode}

• Contact owner

  Token name	Token syntax
  First Name	{ownerfield=firstname}
  Last Name	{ownerfield=lastname}
  Email	{ownerfield=email}
  Position	{ownerfield=position}
  Signature	{ownerfield=signature}

• Company

  Token name	Token syntax
  Address Line 1 (Company)	{contactfield=companyaddress1}
  Address Line 2 (Company)	{contactfield=companyaddress2}
  Annual Revenue (Company)	{contactfield=companyannual_revenue}
  City (Company)	{contactfield=companycity}
  Country (Company)	{contactfield=companycountry}
  Description (Company)	{contactfield=companydescription}
  Email (Company)	{contactfield=companyemail}
  Fax (Company)	{contactfield=companyfax}
  Industry (Company)	{contactfield=companyindustry}
  Name	{contactfield=companyname}
  Number of Employees (Company)	{contactfield=companynumber_of_employees}
  Phone Number (Company)	{contactfield=companyphone}
  State (Company)	{contactfield=companystate}
  Website (Company)	{contactfield=companywebsite}
  Zip Code (Company)	{contactfield=companyzipcode}

• Custom fields

  Date and Time

  When working with date and time fields, you can specify date and time formats based on your Mautic's settings.

  Token name	Token syntax
  Date and Time	{contactfield=aliasofyourcustomdatefield|datetime}
  Date only	{contactfield=aliasofyourcustomdatefield|date}
  Time only	{contactfield=aliasofyourcustomdatefield|time}

  Replace aliasofyourcustomdatefield with the alias of your custom field.

Email specific

The following tokens are available for use only within the email builder.

• Email specific tokens

  Token name	Token syntax
  Signature	{signature}
  Subject	{subject}
  Unsubscribe text (HTML link)	{unsubscribe_text}
  Unsubscribe URL	{unsubscribe_url}
  Resubscribe URL	{resubscribe_url}
  Web view text	{webview_text}
  Web view URL	{webview_url}

Landing pages

Customize content within the landing pages builder.

• Landing pages

  Token name	Token syntax
  Meta description	{pagemetadescription}
  Title	{pagetitle}
  Language bar	{langbar}
  Share buttons	{sharebuttons}

• Preference Center landing page

  Token name	Token syntax
  Lead identifier	{leadidentifier}
  Category list	{categorylist}
  Segment list	{segmentlist}
  Preferred channel	{preferredchannel}
  Channel frequency	{channelfrequency}
  Save preferences button	{saveprefsbutton}
  Success message	{successmessage}

• Components

  Token name	Token syntax
  Asset link for Asset id#	{assetlink=25}
  Focus Item id#	{focus=4}
  Form id#	{form=83}
  Landing Page link for page id#	{pagelink=17}

Forms

Redirect URLs for forms can contain variables by using tokens (e.g. /thank-you?email={formfield=email})

• Redirect URL specific

  Token name	Token syntax
  Field value	{formfield=alias}
  Landing page	{pagelink=ID}

Other tokens

• Dynamic Content

  Token name	Token syntax
  [Dynamic Content 1] | for example User-defined variable name	{dynamiccontent="Dynamic Content 1"}

• Contact monitoring

  Token name	Token syntax
  Language	{language}
  Title	{title}
  Landing Page Title	{page_title}
  URL	{url}
  Landing Page URL	{page_url}
  Referrer	{referrer}
  Tracking pixel	{tracking_pixel}
  UTM Campaign	{utm_campaign}
  UTM Content	{utm_content}
  UTM Medium	{utm_medium}
  UTM Source	{utm_source}
  UTM Term	{utm_term}

Search Operators

• Search operators

  +term: Find the exact term. For example, +admin will find 'admin' but not 'administrator'.

  !term: Exclude terms. For example, !lead will exclude results containing 'lead'.

  "phrase": Search for an exact phrase. For example, "John Doe" will find contacts with that exact name.

  (term1 OR term2): Group parts of your search. For example, (email OR social) will find results containing either 'email' or 'social'.

  term1 OR term2: Include results for either of multiple terms. For example, email OR social.

  %term%: Use as a wildcard. For example, %technologies% will find any contacts with 'technologies' in their company name.

Specific Search Commands

• API Credentials (Applications)

  Identification

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

• Assets

  Identification

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:uncategorized: Filters for items that have not been assigned to any category

  is:mine: Filters for items that are owned by or assigned to the current user

  category:{category alias}: Filters items by a specific category (use the category alias)

  lang:{lang code}: Filters assets by a specific language code

• Campaigns

  Identification

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:uncategorized: Filters for items that have not been assigned to any category

  is:mine: Filters for items that are owned by or assigned to the current user

  category:{category alias}: Filters items by a specific category (use the category alias)

• Emails

  Identification

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:uncategorized: Filters for items that have not been assigned to any category

  is:mine: Filters for items that are owned by or assigned to the current user

  category:{category alias}: Filters items by a specific category (use the category alias)

  lang:{lang code}: mautic.core.searchcommand.lang.description

• Forms

  Identification

  name:*: Searches for items by name

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:uncategorized: Filters for items that have not been assigned to any category

  is:mine: Filters for items that are owned by or assigned to the current user

  is:expired: Filters for forms that have passed their expiration date

  is:pending: Filters for forms that are scheduled but not yet active

  has:results: Filters for forms that have received submissions

  category:{category alias}: Filters items by a specific category (use the category alias)

• Contacts

  Identification

  name:*: Searches for items by name

  email:*: Searches for items by email address

  email:*: Searches notes for contacts by email address

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Interactions

  email_sent:EMAIL_ID: Filters contacts who have been sent a specific email

  email_read:EMAIL_ID: Filters contacts who have read a specific email

  email_queued:EMAIL_ID: Filters contacts who have a specific email queued to be sent

  email_pending:EMAIL_ID: Filters contacts who have a specific email pending

  Filters

  is:anonymous: Filters for contacts that are anonymous (not identified)

  is:mine: Filters for items that are owned by or assigned to the current user

  is:unowned: Filters for contacts that are not assigned to any user

  segment:{segment_alias}: Filters contacts by a specific segment (use the segment alias)

  company:*: Filters contacts by company name

  company_id:*: Filters contacts by company ID

  owner:*: Filters for contacts owned by a specific user

  ip:*: Filters for contacts by IP address

  tag:*: Filters contacts by a specific tag

  stage:*: Filters contacts by a specific stage

  common:{segment_alias} + {segment_alias} + ...: Finds contacts that are common among the specified segments

  page_source:*: Filters contacts by the source of the page they visited

  page_source_id:*: Filters contacts by the ID of the page source

  import_id:*: Filters contacts by a specific import ID

  import_action:*: Filters contacts by a specific import action

  page_id:*: Filters contacts who have visited a specific page (by ID)

  sms_sent:*: Filters contacts who have been sent a specific SMS

  web_sent:*: Filters contacts who have been sent a specific web notification

  mobile_sent:*: Filters contacts who have been sent a specific mobile notification

  title:*: Searches contacts by their title

  firstname:*: Searches contacts by their first name

  lastname:*: Searches contacts by their last name

  company:*: Searches contacts by their company name

  position:*: Searches contacts by their job position

  mobile:*: Searches contacts by their mobile phone number

  phone:*: Searches contacts by their phone number

  points:*: Searches contacts by their point total

  fax:*: Searches contacts by their fax number

  address1:*: Searches contacts by their primary address

  address2:*: Searches contacts by their secondary address

  city:*: Searches contacts by their city

  state:*: Searches contacts by their state or province

  zipcode:*: Searches contacts by their zip or postal code

  country:*: Searches contacts by their country

  preferred_locale:*: Searches contacts by their preferred language/locale

  timezone:*: Searches contacts by their timezone

  last_active:*: Searches contacts by their last active date

  attribution_date:*: Searches contacts by their attribution date

  attribution:*: Searches contacts by their attribution value

  website:*: Searches contacts by their website URL

  facebook:*: Searches contacts by their Facebook profile

  foursquare:*: Searches contacts by their Foursquare profile

  instagram:*: Searches contacts by their Instagram profile

  linkedin:*: Searches contacts by their LinkedIn profile

  skype:*: Searches contacts by their Skype username

  twitter:*: Searches contacts by their Twitter handle

• Landing Pages

  Identification

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:uncategorized: Filters for items that have not been assigned to any category

  is:mine: Filters for items that are owned by or assigned to the current user

  category:{category alias}: Filters items by a specific category (use the category alias)

  lang:{lang code}: mautic.core.searchcommand.lang.description

  is:prefcenter: Filters for pages that are designated as preference centers

• Point Actions

  Identification

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:uncategorized: Filters for items that have not been assigned to any category

  is:mine: Filters for items that are owned by or assigned to the current user

  category:{category alias}: Filters items by a specific category (use the category alias)

• Reports

  Identification

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:mine: Filters for items that are owned by or assigned to the current user

• Stages

  Identification

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:uncategorized: Filters for items that have not been assigned to any category

  is:mine: Filters for items that are owned by or assigned to the current user

  category:{category alias}: Filters items by a specific category (use the category alias)

• Users

  Identification

  email:*: Searches for items by email address

  name:*: Searches for items by name

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:published: Filters for items that are currently active/available for use

  is:unpublished: Filters for items that are currently inactive/unavailable

  is:admin: Filters for users with administrative privileges

  position:*: Filters users by their position in the organization

  role:*: Filters users by their assigned role

  username:*: Searches for users by their username

• Roles

  Identification

  name:*: Searches for items by name

  ids:ID1,ID2: Enables lookup of specific items using their unique identifiers (comma-separated, no spaces)

  Filters

  is:admin: Filters for users with administrative privileges