Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties

Platform URL

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

API Endpoints

Fetch all associated forms

GET https://{enterprise}.cvtr.io/api/v4/campaigns

Update association

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

Remove association

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

DELETE https://{enterprise}.cvtr.io/api/v4/form-campaigns/{campaignid}

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

Save As New

Fetch campaigns

GET https://{enterprise}.cvtr.io/api/v4/campaigns

Include translated forms

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

Save as new

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

Epic

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyGFR-50

Document status

Status
titleDRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad Barnaby Murtagh (Unlicensed) Arunima Kurup Prasad

Related Content

Forms

🏠 Feature Overview

...

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

...

Pending Batches

...

Users can see the table listing of all the files ready to be sent

...

Pending Batches > Configure

...

Redirects the user to the batch CSV integration config

...

Pending Batches > View

...

Allows the user to which leads are queued to be sent

...

Pending Batches > Batch now

...

Allows the user to override the schedule and push the file through immediately

...

Sent Batches

...

Users can see the table listing of all the files that have been sent

...

Sent Batches > View

...

Allows the user to which leads have been sent

...

Sent Batches > Download

...

Users can download the file that have been sent

...

Table Filtering

...

Allows the user to filer the table values using Advertiser Id, Advertiser Name, Campaign Id, Campaign Name and Label

...

Custom Tables

...

A user can add, remove and reset columns for custom table

\uD83D\uDDD2 User Permissions

...

Form Association allows users to select form they wish to assign to campaigns in order to process leads that are submitted via said form.

Name

Required

Notes

Campaign

(error)

Search input to select a Campaign to associate a form with.

Associate A Form To A Campaign

Once your form has been created, either from scratch or via CSV, you will need to associate it to a campaign.

  1. Within the Forms tab on the left navigation, select the link next to your form under the Associated Campaigns column:

    1. If you are associating a new form, this column will display "0 Campaigns"

      demo.pngImage Added
    2. If associating a form which has existing campaign assiciations, the form will say "X Campaigns", based on the number of campaigns that that form is currently associated with.

      1. You can Associate by clicking the "X Campaigns" hyperlink

        Image Added
      2. Or by clicking ‘Edit’ in the ‘Actions’ column, and clicking the ‘Associate’ button

        Image Added
  2. Within the Campaigns field, select the campaign(s) dropdown.

    mceclip0.pngImage Added
  3. Select the Campaign you want to Associate the Form with.

    Image Added
  4. Click “Add”. The selected campaign is then displayed in a table. This will make the form available to the campaign(s). You can add multiple campaigns to a form at once. 

    Image Added
  5. Click ‘Save’ to persist the changes. The form will now be associated to the chosen campaigns.

    Screen_Shot_2021-10-18_at_1.12.35_PM.pngImage Added

How To Disassociate A Form From A Campaign

Note: You can archive a form whilst it still has associated campaigns. If you want to delete the Form then you will have to disassociate all connections i.e. Landing pages, Campaigns, Assets etc. and then it will be available to archive.

  1. Within the Forms tab on the left navigation, select the link within the Associated Campaigns column

    campaigns.pngImage Added
  2. Click Remove beside each campaign

    mceclip1.pngImage Added
  3. Click 'Save' to remove the associated campaigns.

    Screen_Shot_2021-10-18_at_1.12.35_PM.pngImage Added

Save As New

The ‘Save As New’ button option is available in 2 places in Global Forms.

  1. Under ‘Actions’ column on the Active Forms listing page

    Image Added
  2. Or in the ‘Build’ panel when clicking the ‘Edit’ button of a form

    Image Added

The ‘Save As New’ option allows users to save an existing form with a new name, slug and different campaign associations.

This option is available only for ‘Master’ forms and not for ‘Translated' forms.

  1. Click on the ‘Save As New’ button available beside the form or in the ‘Edit Form’ interface. It opens up the ‘Save As New' modal shown below.

    Image Added
  2. On step 1 (Setup), provide a name for the new form. If the original form has associated translated forms, they can be included using the ‘Include Translated Forms’ toggle. If enabled, new (saved as new) version of the translated forms will also be created. If disabled, translated forms will be ignored.

    Image Added
  3. On Step 2 (Associate), the campaigns that need to be associated with the new form can be selected from the dropdown as shown below. User can associate multiple campaigns to the form.

    Image Added
  4. Similar to ‘Associate A Form To A Campaign’ section, associated campaigns will be displayed in a table as shown below.

    Image Added
    1. Clicking on the ‘Advertiser Name’ hyperlink will redirect the user to the Advertiser’s campaign listing.

    2. Clicking on the ‘Campaign Name’ hyperlink will redirect the user to the Campaign’s overview page.

  5. Associated Campaigns may be removed using the ‘Remove’ button. When all changes are made, user can save the changes by clicking on the ‘Save’ button.

    mceclip1.pngImage Added
  6. A new form is now created using ‘Save As New’ option, and associated translated forms are available on the Active Forms listing page.

    Image Added
    1. ‘Save As New’, ‘Edit’ and ‘Preview’ options are available beside the ‘Master’ form created.

    2. ‘Edit’ and ‘Preview’ options are available beside the ‘Translated’ forms created.

\uD83D\uDDD2 Summary

Functionality

User Story

1

Associate Form to Campaign

User can ‘Add’ a form to a campaign so that leads can be submitted via the form and the submissions will be associated to the campaign.

2

Disassociate Form from Campaign

Users can ‘Remove’ a Form from a Campaign

3

Save As New

Users can use the ‘Save As New’ button to save an existing form with a new name, slug and campaign associations.

\uD83D\uDDD2 User Permissions

Admins, agency users and creative manager users have access to Forms.

Agency users have edit permissions only if it is enabled at enterprise level.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=415459484