Custom invite fields allow you to add tailored questions to your locations' invite forms. Users encounter these questions when they are creating invites from the web portal, prior to sending the invite out to their visitors. These fields can can be made mandatory, optional, or conditional.
The sections below include:
Creating Custom Fields
Custom fields can be built in any location:
1. Open the location you'd like to edit, then click the Preferences button in the top-right corner.
2. Select Custom fields preferences.
3. Click Add custom field, then Create new.
You can now define your question with these settings:
Custom Field Type: Choose between Text Input (free-form input) or Select Input (presents a picklist of pre-defined options).
If you've chosen the Select input, you will see an Add option button at the bottom of the screen which allows you to customize your picklist choices.
Label: Enter the question that a user will see when they encounter this custom field.
Data Name: This is an internal identifier for the question and is not visible to your users. It’s automatically generated based on your label but can be customized. Ensure it’s unique for future reference.
Description (Optional): You can provide additional instructions or context for the question.
Click Save when you are done making changes.
Adding Custom Fields to a Location
After creating a custom field, it will automatically be added to your location. You can add more custom fields by clicking the Add custom field button.
You must also choose whether the field is required. In the 'Is required?' dropdown, choose between Yes, No, and Conditional. If you choose Yes, a user will not be able to save the invite without answering the question. The rules around the Conditional option are covered in this section below.
Editing and Deleting Custom Fields
Custom Fields can be edited and deleted from the Preferences page. To access it:
1. Click the gear icon in the top-right corner, then Preferences.
2. Select the Custom fields tab.
3. Click the label of the custom field you'd like to edit. Or, click the 3 dots to the right of the question to see the Delete option.
NOTE: You can edit every field except for the data name. This is locked in when the field is first created.
Conditional Invite Fields
Conditional custom fields enable you to create dynamic forms where certain questions become mandatory based on the responses to previous questions. This feature is particularly useful for gathering additional information from your user only when necessary.
For example, you can set up a flow that asks "What is your visitor's citizenship?". If the answer is 'US', then users must then answer the question: "Does your visitor have a valid piece of US ID?"
Adding Conditional Custom Fields
First, ensure that your starting fields/questions are added into your location. These are the questions that must be answered first to then determine what other questions must then be conditionally answered.
These fields can be added from each location:
1. Click the Preferences button in the top-right corner.
2. Select Custom Fields Preferences.
3. Click Add custom field and either add from existing fields or create new fields.
4. In the 'Is required?' dropdown box next to each field, choose Yes, No, or Conditional.
Setting Up Conditional Logic - Implementing Regex
After you've set a field to be Conditional, you must now determine which previously answered question it will be based on. A text box will appear which requires that you input prompts using a syntax called Regex (regular expressions).
At its core, the structure follows a basic pattern that can be copy/pasted for most use-cases. However, if you are not already familiar with using Regex, we recommend setting up a call with our support team for your first go at it.
In essence, most fields can be written as follows: flexFields['DataNameHere'] == 'AnswerToQuestionHere'
You simply need to replace the bolded fields with the details of your specific questions.
Adding your Data Name
The Data Name is the unique identifier for the question you'd like to reference. If you need a refresher on what your data names are, click the Preferences > Custom fields link at the bottom of the custom fields preferences page. Then, click the Custom fields tab and copy the Data Name for the question you're referencing.
In the example below, we want to reference the question that asks 'What is your visitor's citizenship?'. The data name is 'what_is_your_visitors_citizenship', so we would input it into the regex like this:
flexFields['what_is_your_visitors_citizenship'] == 'AnswerToQuestionHere'
Adding The Answer to Your Question
Following the example above, we now want to make the conditional field mandatory only if the visitor's citizenship is 'US'. The user could only choose between US, Canadian, or Other. If the citizenship is US, the user must now answer the question "Does your visitor have a valid US ID?'
To reference this answer in the Regex, simply enter 'US' after the equal signs and in-between the quotation marks. The full regex expression now looks like this:
flexFields['what_is_your_visitors_citizenship'] == 'US'
Remember to hit Save when you are done making changes. If your Regex syntax is incorrect, you will see an error preventing you from saving.
What Do Your Users See?
When a user creates an invite from the admin portal, all of your custom fields will appear in the order you've added them, including your conditional fields. All conditional fields will display a tag that says '(optional)' at the end of the question. When the condition is met, the optional tag will disappear and the question is now mandatory.
In the example below, the user is asked 'What is your visitor's citizenship?'. If the answer is 'US', then the question below is no longer optional. It asks 'Does your visitor have a valid US ID?'
