Platform URL | https://[enterprise].cvtr.io/v2/forms |
|---|---|
API Endpoints | Add form via Add button/CSV file and Edit form
|
Epic | GFR-50 - Getting issue details... STATUS |
Document status | DRAFT |
Document owner | |
Technical writers | |
Related Content |
đ Feature Overview
Forms provide a centralised management area allowing users to Add and Edit forms which can then be associated to campaigns to allow capturing of lead information.
Adding a new form:
Navigate to âFormsâ in the sidebar
On the âActive forms' tab, click the âAddâ button
Editing forms:
Navigate to âFormsâ in the sidebar
On the âActive Formsâ tab, in the âActionsâ column, click the âEditâ button on the form that requires changes
Add/Edit form âSetupâ step:
On the setup tab, complete the required fields:
Name: The form name
Slug: The URL for your form which will format as:
https://ENTERPRISENAME.cvtr.io/forms/CAMPAIGNID/FORMSLUG
The slug field will be automatically populated based on the entered form name, however this can be changed. It must be lowercase, without any capital letters and without symbols, apart from dash which will replace any spaces.Language: This is a whitepaper feature where forms with different languages can be created. More details here.
Embed Type: Forms can be embeded via a Javascript tag or iframe tag. If convertr âlanding pageâ functionality is being used then iframe is the correct âtypeâ to use. If embeding a form manually on your own website (likely in conjunction with whitepaper functionality) then the âjavascriptâ option is the tag type to use.
Auto iframe resizing: If the âiframeâ embed type is chosen and iframe resizing is enabled, the height of the iframe will automatically adjust itself depending on the content of the iframe, preventing scrollbars on the iframe. If disabled, the height of the iframe will have to be manually declared vis custom CSS declarations to avoid scrollbars when embeding the form.
Add/Edit form âFieldsâ step:
By default, various fields will be included with a new form:
Provide an overview of the feature and describe:
users who can access the page on the platform
widgets available to the users
functionalities available: Listing page, add, edit, delete, download etc. with screenshots
for add/create modals, provide details of the fields to be submitted to complete the action
E.g.
Name | Required | Notes |
Agency Name |
| Name has to be unique |
First Name |
| Â |
Last Name |
| Â |
Email(s) |
| It is possible to add multiple mail ids |
Telephone |
| Â |
Notes |
| Â |
search and filter options available on table columns, if any
custom table views, pagination, if available
\uD83D\uDDD2 Summary
Summarise the functionalities in a table
Functionality | User Story | |
|---|---|---|
| 1 | Pending Batches | Users can see the table listing of all the files ready to be sent |
| 2 | Pending Batches > Configure | Redirects the user to the batch CSV integration config |
| 3 | Pending Batches > View | Allows the user to which leads are queued to be sent |
| 4 | Pending Batches > Batch now | Allows the user to override the schedule and push the file through immediately |
| 5 | Sent Batches | Users can see the table listing of all the files that have been sent |
| 6 | Sent Batches > View | Allows the user to which leads have been sent |
| 7 | Sent Batches > Download | Users can download the file that have been sent |
| 8 | Table Filtering | Allows the user to filer the table values using Advertiser Id, Advertiser Name, Campaign Id, Campaign Name and Label |
| 9 | Custom Tables | A user can add, remove and reset columns for custom table |
\uD83D\uDDD2Â User Permissions
Mention if access needs to be enabled for any user roles and attach the user matrix.