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 Current »

Platform URL

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

API Endpoints

Retrieves the collection of Archived Forms:

GET https://{enterprise}.cvtr.io/api/v4/forms&enabled=false

Retrieving a Form:

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

Deletes a Form:

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

Creates a Form preview:

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

Removes the campaign from the Form:

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

Epic

GFR-50 - Getting issue details... STATUS

Document status

DRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad

Related Content

Forms

šŸ  Feature Overview

With the Global Forms section, instead of creating individual forms for each campaign, users can create master templates and associate them to multiple campaigns. Users can view and manage forms across all campaigns using the Global Forms sections available on the left menu.

Archived Forms

Forms can be archived by selecting the associated checkbox(es) and clicking on the ā€˜Archiveā€™ button on the Active Forms listing page. The ā€˜Archiveā€™ button will be enabled only when at least 1 form is selected.

By clicking on ā€˜Yesā€™ in the ā€˜Archive Formsā€™ modal, the form will be archived and will move to the ā€˜Archived Formsā€™ tab. ā€˜Translatedā€™ forms created from the form being archived, will also move to the Archived Forms listing. If required, translated forms may be re-activated.

Listing Page

All forms that are archived are listed under the ā€˜Archived Formsā€™ tab in Global Forms page. Archived forms associated with campaigns will continue to work with linked email assets, landing pages and connected apps.

Archived forms are not shown when creating landing pages, creating email assets, creating connected apps and importing leads.

The listing page for archived forms is shown below.

The table shows:

  • ID: unique ID of the form. Users can search for a form using the ID.

  • Form: name of the form. Users can search for a form using the form name.

  • Associated campaigns: provides a link to all campaigns using the form

  • Actions column provides the option to view the ā€˜Previewā€™ of archived forms

  • Checkbox: A checkbox column is provided for selecting the forms that need to be activated or deleted. The ā€˜Activateā€™ button and ā€˜Deleteā€™ button will be enabled only when at least 1 form is selected.

  • The forms listing page provides pagination option so users can select how many forms they want to view on a page.

Associated Campaigns

  • Clicking on the hyperlink opens the below modal showing all associated campaigns

A blue banner displays the number of campaigns associated with the form but users will only be able to see the campaigns that they have permission to access.

Clicking on the ā€˜Campaign Nameā€™ hyperlink takes the user to the campaign overview page.

Clicking on the ā€˜Advertiser Nameā€™ hyperlink takes the user to the advertiserā€™s campaign listing page.

Removing associations

A campaign association with a form can be removed using the ā€˜Removeā€™ button if the form does not have any associations to:

  • Landing pages

  • Email assets

  • ConnectedApps

If the form is associated with any the above, the following error message will be shown which displays the ID of the landing page/email asset/connected app association.

Once the form associations are removed, the campaign association with the form can be removed by clicking on ā€˜Removeā€™ and ā€˜Saveā€™.

Preview

By clicking on the ā€˜Previewā€™ button available in the Actions column, the user can see a preview of the ā€˜Fields Pageā€™ of the archived form, and the ā€˜Thanks Pageā€™ of the archived form.

Activate Form

An archived form will need to be re-activated for it to be associated with campaigns. Forms can be re-activated by selecting the associated checkbox(es) and clicking on the ā€˜Activateā€™ button on the Archived Forms listing page. The ā€˜Activateā€™ button will be enabled only when at least 1 form is selected.

By clicking ā€˜Yesā€™ on the above confirmation dialog box, selected archived forms will be activated and will move back to ā€˜Active Formsā€™ listing page.

Delete Form

Only archived forms can be deleted. Forms can be deleted by selecting the associated checkbox(es) and clicking on the ā€˜Deleteā€™ button on the Archived Forms listing page. The ā€˜Deleteā€™ button will be enabled only when at least 1 form is selected.

Upon clicking Delete, a confirmation dialog will be shown to the user to confirm the action.

By typing in the confirmation message and clicking on Yes, the form will be deleted from the platform. Any translated forms created from the form being deleted, will also be automatically deleted.

Forms having any campaign associations cannot be deleted, the following error message will be shown.

The user has to remove campaign associations with forms in order to delete forms.

\uD83D\uDDD2 Summary

Functionality

User Story

1

Archived forms listing

Lists all archived forms, their type and associations

2

Activate form

Allows the user to reactivate archived forms

3

Associated campaigns

Allows user to view all campaign association, and remove campaign associations

4

Delete Forms

Allows the user to delete archived forms

5

Preview

Allows the user to preview form fields page and thanks page

6

Table Filtering

Allows the user to filer the table values Form Id and Form Name

\uD83D\uDDD2Ā User Permissions

Admin, agency users and creative managers have access to global forms.

Agency users can perform edit actions only if access is enabled at enterprise level.

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

  • No labels