Pre-populate form link

Documentation Home

What is the Pre-populate form link?

A Pre-populate form link lets you indicate values to be set as the form loads through parameters in the URL.

How to Use the Pre-populate form link

On the "Share" page, go to the "Pre-populate form" section. Copy the URL to edit the pre-defined values to suit your needs.

The general format for the Pre-populate form link is:

https://fsX.formsite.com/yourAccount/yourForm/fill?itemPosition=YourValue
  • itemPosition: The position of the item on the form, including the sub-question position in the case of Matrix items. Alternatively, the item's id can also be used, as shown on the item's edit settings page or at the "Form Settings->Integrations->API" page, using the format idX=value.
  • YourValue: The URL encoded value with which to populate the given item

You can edit the link to include the items and values you wish to use. For text-based items like Short Answer fields, the value should be the text you want to display. For multiple-choice-based items like Radio Buttons and Checkboxes, the value should be the position of the choice, or choices, you want selected. Please note that all values should be URL encoded to prevent issues with special characters, and each Name-Value pair in the link should be separated with "&", as shown below.

Note: For multi-page forms, only items on the first page of the form can be pre-populated.

Note: Pre-populate does not work with Save & Return.

Pre-populate form link Example

Following is an example of the Pre-populate form link for a form with Short Answer, Radio Button, Checkbox, Dropdown, Radio Button Matrix, and Checkbox Matrix items.

Pre-populate

This form could be pre-populated as shown using a link like:

https://fsX.formsite.com/dir/formX/fill?2=First+Lastname&3=1&4=1&4=4&5=1&6-1=1&6-2=3&6-3=2&7-1=3&7-2=1&7-2=2&7-2=3&7-3=1

In the above URL,

  • "2=First+Lastname" fills the Short Answer item in position 2 with "First Lastname".
  • "3=1" fills the Radio Button item in position 3 with its position 1, "Parent".
  • "4=1&4=4" fills the Checkbox item with two selections: 4 is the position of the Checkbox item and positions 1 & 4 are selected, "Driving" and "Tear-down".
  • "5=1" fills the Dropdown item in position 5 with its position 1, "Camping".

 

The Matrix Items are similar but also include a reference to the desired sub-question:

  • "6-1=1" fills the item in position 6 sub-question 1 with its position 1, "not".
  • "6-2=3" fills the item in position 6 sub-question 2 with its position 3, "very".
  • "6-3=2" fills the item in position 6 sub-question 3 with its position 2, "somewhat".

 

  • "7-1=3" fills the item in position 7 sub-question 1 with its position 3, "Evening movie".
  • "7-2=1" fills the item in position 7 sub-question 2 with its position 1, "Swimming".
  • "7-2=2" fills the item in position 7 sub-question 2 with its position 2, "Canoeing".
  • "7-2=3" fills the item in position 7 sub-question 2 with its position 3, "Evening movie".
  • "7-3=1" fills the item in position 7 sub-question 3 with its position 1, "Swimming".

 

Alternatively, the item's id can be used in place of its position,

https://fsX.formsite.com/dir/formX/fill?id21=First+Lastname
  • "id21=First+Lastname" corresponds to the item whose "id" is "21", and it will be pre-populated with the text "First Lastname". In this example, this could take the place of "2=First+Lastname" above, assuming the Short Answer's id is "21". You can find the ids for your form items at the "Form Settings->Integrations->API" page or in the Form Editor at the bottom of each item's edit window. It can be helpful to use the item ids rather than their position since the ids will not change if you add or move items.

As shown in the example below, you can combine these two approaches into a Pre-populate form link where you can use id for a form item and display position for another.

https://fsX.formsite.com/dir/formX/fill?id21=First+Lastname&3=1&4=3

Additional Information

These items do not support the Pre-populate form link:

  • File Upload
  • Rating
  • Ranking
  • Multi-scale

Documentation Home