Platform URL | https://[enterprise].cvtr.io/v2/forms | ||||||||
|---|---|---|---|---|---|---|---|---|---|
API Endpoints | Add form via Add button/CSV file and Edit form
| ||||||||
Epic |
| ||||||||
Document status |
| ||||||||
Document owner | |||||||||
Technical writers | |||||||||
Related Content |
...
Field Name | Required | Notes |
Name |
| The form name |
Slug |
| The slug is the URL for your form which will format as: |
...
Click the ‘Save’ button. This will take you to the form builder of which follows the same building/editing process as the ‘Editing Forms’ section below. Fields will automatically be added as Text fields and can be changed if required during the editing process.
...
On the ‘Active Forms’ tab, in the ‘Actions’ column, click the ‘Edit’ button on the form that requires changes
...
Form steps and navigation:
...
There are 5 sections when editing a form. Once the ‘setup’ step is complete, all other still stages will then be accessible.
...
Navigating between the steps can be done by clicking the tab names, or by clicking the ‘Back’ and ‘Next’ buttons in the panel footer. The ‘save’ button will become enabled once the ‘setup’ step is completed.
Form ‘Setup’ step:
On the setup tab, complete the required fields:
...
Field Name | Required | Notes |
Name |
| The form name |
Slug |
| The URL for your form which will format as: |
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. |
...
Each field may have additional settings which can be accessed via this button. Each field type may have different settings and are documented here (awaiting documentation link).
Field Actions:
Each field has various actions:
...
When a change is made to the form, clicking the ‘Refresh’ button will apply any changes made to the previous preview output.
There is a different tab for previewing the ‘Fields Page’ and the ‘Thanks Page', each of which require clicking the ‘Refresh’ button to see any new changes made.
\uD83D\uDDD2 Summary
...
Functionality | User Story | |
|---|---|---|
| 1 | Forms > Add | Build a brand new form. |
| 2 | Forms > Add Via CSV | Build a form using a CSV file for occasions where lots of fields need to be added and manually building would take too much time. |
| 3 | Forms > Edit | Edit various form settings. |
| 4 | Forms > Edit > ‘Build’ Panel > ‘Setup’ Step | Set the form name, slug, and change other settings such as language, embed type and autosizing. |
| 5 | Forms > Edit > ‘Build’ Panel > ‘Fields Page’ Step | Edit the form fields to be included on the form. |
| 6 | Forms > Edit > ‘Build’ Panel > ‘Thanks Page’ Step | Edit the stage of the form to be shown once all required fields on the form have been completed and the ‘submit’ button is clicked. |
| 7 | Forms > Edit > ‘Build’ Panel > ‘CSS’ Step | Control the visual style of the form. |
| 8 | Forms > Edit > ‘Build’ Panel > ‘Javascript’ Step | Add any custom javascript to the form. |
| 9 | Forms > Edit > ‘Preview’ Panel | Preview the appearance of the form during the build process. |
\uD83D\uDDD2 User Permissions
...