Relevant to: Event Lead Management
| This feature is primarily of use to customers using the Public API to customize the Event Lead Management system. |
When using the Event Lead Management public API, Field IDs act to distinguish between different question fields within a form. The system automatically assigns question fields with specific Field IDs (these are not visible in the Form Builder).
It is usually best to leave Field IDs as the default value because it reduces the risk of error. However when using the public API, you may want to change a Field ID so that it can be easily identified in accordance with your system requirements and how you intend on using/transforming the data. This article explains how to change Field IDs in the Form Builder.
In this article
Formatting the Field ID
Field IDs usually include one or two words from the question title with the second word capitalized eg. fullName, eventDate. Typically, this will feature the last two words from the question title.
There is no limit to the number of characters that can be used in a Field ID, but it is recommended that they are kept short and consistent - and only consist of text characters (not numbers, symbols or spaces).
Example: Field IDsYou add two questions in the Form Builder and the following Field IDs are automatically generated:
Say you are happy with the Field ID for Event Date because it clearly describes the form field (and the associated values). However, the second Field ID is not clear. You therefore decide to change it to a more relevant Field ID:
You can make this change in the Form Builder - see the following instructions. |
Changing a Field ID
1. Create a new Event or open an existing one and navigate to the Form Builder. Click the question field that you want to edit.
2. In the field options box, go to The Question. After the question title, add a semi-colon and the new Field ID. This should be formatted as follows (with a space before and after the semi-colon):
yourQuestionTitle ; newFieldId
For example:
What type of event is this? ; eventType
3. Click Save & Finish.
Recommended Reading