Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

Platform URL

https://[enterprise].cvtr.io/v2/forms

API Endpoints

Add form via Add button/CSV file and Edit form

GET https://{enterprise}.cvtr.io/api/v4/features?name=global_forms_agency_edit

GET https://{enterprise}.cvtr.io/api/v4/input-types

GET https://{enterprise}.cvtr.io/api/v4/content-languages

POST https://{enterprise}.cvtr.io/api/v4/forms

POST https://{enterprise}.cvtr.io/api/v4/form-preview

Epic

GFR-50 - Getting issue details... STATUS

Document status

DRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Amish Ladhu Arunima Kurup Prasad

Related Content

Forms

🏠 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:

  1. Navigate to ‘Forms’ in the sidebar

  2. On the ‘Active forms' tab, click the ‘Add’ button

Adding a new form via CSV:

DO THIS

Editing forms:

  1. Navigate to ‘Forms’ in the sidebar

  2. 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 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:

  1. Name: The form name

  2. 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.

  3. Language: This is a whitepaper feature where forms with different languages can be created. More details here.

  4. 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.

  5. 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.

Form ‘Fields’ step:

Default fields:

By default, various fields will be included with a new form:

  • First Name

  • Last Name

  • Email Lookup

  • Telephone Lookup

  • Optin

  • Submit

Field settings:

Each field has various settings:

  • Type

    • The type of input. This includes standard HTML field types, ESP lookups, multiple choice fields, prepopulated lists, stanard lookups (e.g. email, telephone, address, etc.), whitepaper related fields and other miscellaneous fields.

  • Name

    • The name of your field (which is used as the field label once the lead is captured against this form)

  • Enable

    • This allows field types to be added to the form, and upon disabling, it can be hidden from view when viewing the form.

  • Required

    • Dictates if the form is a required field when being completed.

  • Required Message

    • Works in conjunction with the ‘required’ toggle where a tooltip appears containing the text entered in this setting item if the user clicks ‘Submit’ on the form without competing the field specified.

  • Label

    • Caption for your field type which will show above your input field.

  • Placeholder

    • A short hint to describe the expected value of an input field.

  • CSS Class

    • Add a custom CSS classon the field HTML container.

  • Settings

    • Each field may have additional settings which can be accessed via this button.

Not all fields allow editing of all of the above settings, where any settings that are not available for setup will be disabled and greyed out.

Field Actions:

Each field has various actions:

  • Move

    • Click and drag the button to move the field into the desired position on the form. This position will be reflected when viewing the live form.

  • Delete

    • This will remove the field from the form.

  • Add Input

    • This buttons allows adding of more fields to your form.

Form ‘Thanks Page’ step:

Form ‘CSS’ step:

Form ‘Javascript’ step:

Form preview:

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

(tick)

Name has to be unique

First Name

(tick)

 

Last Name

(tick)

 

Email(s)

(tick)

It is possible to add multiple mail ids

Telephone

(tick)

 

Notes

(error)

 

  • 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.

Convertr User Matrix v.1.2

  • No labels