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

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

GFR-50 - Getting issue details... STATUS

Document status

DRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Barnaby Murtagh (Unlicensed) Arunima Kurup Prasad

Related Content

Forms

🏠 Feature Overview

Form Association allows users to select a Form that they wish to be linked to a Campaign in order to process leads that are submitted via a 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:

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

demo.png

b. If associating a previous form this will say "X Campaigns", based on the number of campaigns that that form is currently associated with. You can Associate by clicking the campaign hyperlink or by clicking ‘Edit’ and selecting the ‘Associate’ button

  1. Within the Campaigns field, select the campaign(s) from the dropdown list that you want to associate. This will make the form available to the campaign(s). You can add multiple campaigns to a form at once. 

mceclip0.png

2. Select the Campaign you want to Associate the Form with

3. Click Add

The associated campaign is displayed in a table as shown below.

4. Click ‘Save’ to persist the changes. The form will now be associated to the selected campaigns.

Screen_Shot_2021-10-18_at_1.12.35_PM.png

 How To Disassociate A Form From A Campaign

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

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

campaigns.png

2. Click Remove beside each campaign

mceclip1.png

3. Click 'Save' to remove the associated campaigns.

Screen_Shot_2021-10-18_at_1.12.35_PM.png

Save As New

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

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

ii. Edit Form interface available on clicking the ‘Edit’ button beside a campaign

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.

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.

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.

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

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

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

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.

5. New form created using ‘Save As New’ option, and associated translated forms are available on the Active Forms listing page.

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

‘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

  • No labels