Versions Compared

Key

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

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

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

Document status

Status
titleDRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Amish Ladhu Arunima Kurup Prasad

Related Content

Forms

...

Field Name

Required

Notes

Name

(tick)

The form name

Slug

(tick)

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.

Language

(tick)

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

Embed Type

(tick)

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

(error)

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:

...

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:

...

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

This section is documented here.

Form ‘CSS’ step:

This tab allows custom styles to be added to the form.

...

Form ‘Javascript’ step:

This tab allows custom Javascript to be added to the form.

...