Follow

Sumo Input Fields

 


Understanding Sumo Fields

Fields are an advanced feature available in List Builder Pro, Scroll Box Pro, and Welcome Mat Pro. Sumo provides both built-in and custom fields for your use.

Built-in fields are text only fields that come with pre-defined variables. Custom fields allow user-defined variables to pass information you need beyond what is provided with built-in fields. Hidden fields can pass both hardcoded text and our predefined variables.

Please make sure you add custom fields with the proper Field Type within your Service Provider if they require them to accept additional fields.

  • Field Name - The name to identify the field in design mode.
  • Field Type - The type of field in use. Many services will need to have the type set in order to pass data properly.
  • Variable Name - Name used to identify a stored value. Example:

    Variable Name = email
    Variable Value = "love@sumo.com".

    When the email love@sumo.com is collected, it is stored in the variable "email"

    Service: "What is the {email} you collected?"
    Sumo: "That {email} is love@sumo.com"

Built-In Fields

Field Name Description Field Type Variable Name
Email Address* This is required and cannot be removed or disabled. You should not need to create a custom field for this in your service. Email* email*
Name These may or may not be included as the same field. Some services combine them and do not need a custom field setting. Most services will allow "Name" but require custom text fields to be generated for First and Last Name. Your service will utilize one of 3 possible variables. Name name
First Name Text first_name, fname, first
Last Name Text last_name, lname, last
Company These should all be created as a text field. If your service offers special fields for Zip, Website, and Phone, they may not be compatible. It is best you create these fields as text fields using the variable names provided. Text company
Zip Code Text zip
Website URL Text website
Phone Number Text phone
Country Dropdown Text country

Custom Fields

Field Name Description Field Type Variable Name
Single-line Text Input This field will allow you to create a text input field to collect whatever text information you would like that is not currently offered in our built in text fields.
EXAMPLE:
Text user-defined
Dropdown list This field allows you to create <select> style lists for your popups.
EXAMPLE:
text, dropdown user-defined
Checkbox input This field allows you to create a single checkbox entry
EXAMPLE:
Purple is my favorite color.
text, checkbox user-defined
Checkbox group This field allows you to create multiple checkbox entries under a single heading. Checkboxes allow multiple selections.
EXAMPLE:
Choose your favorite colors:
Purple
Blue
text, checkbox user-defined
Radio Group This field allows you to create multiple radio (round) selects under a single heading. Radio selections are toggles and only 1 can be selected at a time within the group.
EXAMPLE:
Choose your favorite color:
Purple
Blue
text, radio user-defined
Hidden Value** This field allows you to pass hidden data, not seen by your visitors, to your service. It can pass hardcoded text and our pre-defined variables. Text user-defined, client_ip, country, href, referrer, user_agent, popup_name, popup_slug, campaign_name, campaign_slug

** Pre-defined hidden value variables provided by Sumo

  • {client_ip} - IP of subscriber
  • {campaign_name} - Full name of Campaign that collected the subscriber information. Example: "Campaign #1"
  • {campaign_slug} - Campaign name that collected subscriber information without spaces or special characters. Example: "campaign_1"
  • {country} - Country of subscriber based on geo location of IP
  • {popup_name} - Full name of Popup that collected the subscriber information. Example: "Popup Awesome #1"
  • {popup_slug} - Popup name that collected subscriber information without spaces or special characters. Example: "popup_awesome_1"
  • {referrer} - URL where subscriber came from before subscribing
  • {href} - URL where subscriber subscribed
  • {user_agent} - Name, version and platform of browser used by subscriber
  • {date} - The date the subscription occurred at (in UTC). Example: "2016-11-27"
  • {date_time} - The date and time the subscription occurred at (in UTC). Can be customized! Example: "2016-11-27T18:30:54.432Z"

Setting a custom date/time field

Want to set the {date_time} value to a specific format and/or time zone? No problem.

  • Example: {date_time|DD/MM/YY h:mm a} will pass a value of 11/27/2016 6:30 pm

Want to change the time zone?

  • Example: {date_time|DD/MM/YY h:mm a|America/New_York} from the above example would pass a value of 11/27/2016 1:30 pm

See this list of valid time zones you can use. Click here for more formatting options.


Adding Single Fields to List Builder Pro/Scroll Box Pro

Step 1: Access Fields through the Popup editor window by clicking on the "Fields" tab.

Step 2: Choose the field Type you would like to add. You may choose from any of our Built-in or Custom Fields.

Step 3: Choose a Field Name. This will help to identify the field in your design tab.

Step 4: Choose if you want this field to be required.

Step 5: Choose a Variable Name. Built-in Fields are already configured. Custom Fields will need to have their variable's assigned here.

Step 6: Click on Save before exiting Fields.


Adding Grouped Fields to List Builder Pro/Scroll Box Pro

Step 1: Access Fields through the Popup editor window by clicking on the "Fields" tab.

Step 2: Choose one of our 3 grouped field options: Dropdown list, Checkbox group, Radio group .

Step 3: Choose a Field Name. This will help to identify the field in your design tab.

Step 4: Choose if you want this field to be required.

Step 5: Choose a Variable Name.

Step 6: Click on "Edit Options" to access the "Field Options Editor"

Step 7: Click on "Add Option"

Step 8: Choose a Name and Value. Repeat steps 7 & 8 for every entry you need.

Step 9: Click on Save to exit the "Field Options Editor".

Step 10: Click on Save again before exiting Fields.


Adding Fields to Welcome Mat

Check out our guide on how to add extra input fields in Welcome Mat: GUIDE


Was this article helpful?
0 out of 1 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.