Platform URL | https://[enterprise].cvtr.io/v2/forms | ||||||||
|---|---|---|---|---|---|---|---|---|---|
API Endpoints | Not Applicable | ||||||||
Epic |
| ||||||||
Document status |
| ||||||||
Document owner | |||||||||
Technical writers | |||||||||
Related Content | https://convertr.atlassian.net/wiki/spaces/PF/pages/edit-v2/3058532652 |
🏠 Feature Overview
Once a form is created, user can select the input types to show on the form by going to the ‘Fields Page’ and clicking on ‘Add Input’.
...
This opens the below sections where you can select the input type from the ‘Type’ dropdown.
...
Name
...
Required
...
Notes
...
Type
...
...
Input Type
...
Name
...
...
This name will be used to identify the input field in other areas of the platform such as publisher bands, custom tables etc. Should not contain capital letters, spaces or special characters
...
Enable
...
...
If toggled ON, the field will be displayed on the form. If OFF, the field will not be displayed on the form
...
Required
...
...
This needs to be toggled ON if a field needs to be marked as ‘Required’ with an asterisk on the form. Custom validation message may be added in the textfield provided under ‘Required’
...
Label
...
...
This is the name of the field that will appear on the form
...
Placeholder
...
...
Use this to describe the expected input
...
CSS Class
...
...
Add a custom CSS class on the field HTML container
...
Title
...
First Name
Last Name
Password
Email
Telephone
HiddenInput
OptinTitle
...
This input type can be used on the form to accept the 'Title' of the lead. When selecting the Type as ‘Title’, the ‘Name’ and ‘Label’ fields are automatically populated and user can overwrite the same if required.
The following options are available under Title type by default:
Mr
Ms
Mrs
Miss
Dr
Rev
Clicking on the ‘Settings’ icon shown below opens a modal where user can add additional options for title.
...
Field Settings Modal
...
Adding additional options
Within the ‘Field Settings' modal, under the ‘Fields’ tab, additional options can be added to the title list in 2 ways
i. Users can enter data in the format: {"value":"value1","label":"label1"} and click on the ‘Import’ button
...
ii. Users can enter the label under ‘Label’ and value under ‘Value’ and click ‘Add’.
...
The values added as JSON and added via Add button will be shown in the listing table.
...
Users can remove options from the list using the '-' button available against each option.
...
Users can reorder options in the list using the '+' icon available against each option.
...
Once changes have been made, clicking on the ‘Save’ button will persist the changes to the Title field.
2. First Name
...
This input type can be used on the form to accept the ‘First Name’ of the lead. When selecting the Type as ‘First Name’, the ‘Name’ and ‘Label’ fields are automatically populated and user can overwrite the same if required.
3. Last Name
...
This input type can be used on the form to accept the ‘Last Name’ of the lead. When selecting the Type as ‘Last Name’, the ‘Name’ and ‘Label’ fields are automatically populated and user can overwrite the same if required.
4. Password
...
This input type can be used on the form to accept the ‘Password’. When selecting the Type as ‘Password’, the ‘Name’ field is automatically populated and user can overwrite the same if required. User must provide a ‘Label’ for the input type. The ‘Password’ field masks the input entered by the user as shown in the screenshot above.
5. Email
...
This input type can be used on the form to accept the ‘Email’ of the lead. When selecting the Type as ‘Email’, the ‘Name’ field is automatically populated and user can overwrite the same if required. User must provide a ‘Label’ for the input type.
6. Telephone
...
This input type can be used on the form to accept the ‘Telephone’ of the lead. When selecting the Type as ‘Telephone’, the ‘Name’ and ‘Label’ fields are automatically populated and user can overwrite the same if required.
The Telephone input has 2 parts:
a dropdown to select the Country Code; ‘United Kingdom’ is selected by default. User can select the country code from the dropdown.
text field to provide the telephone number
7. HiddenInput
This input type is for adding fields to the form, which should not be visible to the user.
User is not allowed to add a ‘HiddenInput’ as the first field on the form. An error message ‘Please start creating a form with inputs’ is shown.
...
The user must provide a ‘Name’ for the hidden input field. The fields ‘Required’, ‘Label’, ‘Placeholder’, and ‘CSS Class’ are disabled for this input type.
8. Optin
...