What is a Dynamic URL?
Use a Dynamic URL link to prefill Online Form automation. With an Online Form, your initial landing page or preview window will pop up for recipients to fill out fields such as their first name, last name, and email address. However, if you’ve collected this information on your website, you can pass those parameters using dynamic URLs. When opening the Online Form, signers will not need to enter their duplicate information again.
Bypass Form Submission
Our first parameter of our dynamic URL will be to bypass the form submission. In other words, we will disable the preview pop up window from appearing. This parameter is mandatory. If you would not like this preview window to pop up, use:
‘escapeForm=true’
To keep the preview window, use:
‘escapeForm=false’
Passing Initiator Field Values
Our initiator’s values are the fields we presume you already have information about on your website. These will include first name, last name, and email. The parameters that need to be passed will be below as follows:
&signerFirstName=value&signerLastName=value&signerEmailId=value
Note: Value indicates the value that will be entered in the field after submission.
Example: &signerFirstName=John&signerLastName=Doe&signerEmailId=johndoe@email.com
Passing Recipient Parties Values
To pass a non-fixed recipient parties values:
&party_2_firstName=value&party_2_lastName=value&party_2_email=value
For additional non-fixed recipient parties (if any):
&party_3_firstName=value&party_3_lastName=value&party_3_email=value
Passing Template Field Values
To pass a template’s field values, give the field name defined in the template in the query parameter:
&field_name_in_template=value
Important: To be able to pass the field values with the URL, please enable ‘Show Document Fields on Form’ on the ‘Display Features’ tab of the specific Online Form. If you need to fill the field values but not show them on the modal, you can pass this parameter:
“hideFormFields=true”.
Checkboxes
For checking/unchecking any checkbox, pass ‘true/false’ as its value:
&checkbox_name_in_template=true
OR
&checkbox_name_in_template=false
Custom Fields
A maximum of two(2) custom fields can be added with the dynamic URL that does not show on the form but used as metadata for the folder. Custom fields are passed back with the folder information via the webhook response each time. You can add any custom field and value information in this format:
CustomField1=fieldname&fieldname=12345
Example: CustomField1=SalesforceObjectID&SalesforceObjectID=132121212
Important Notes
- Use ‘&’ as a separator for all parameters.
- Use ‘%20’ or ‘+’ as a space in the value. If you are unsure how to code your field name correctly, use an encode/decode tool
- For checkboxes and radio buttons, pass values such as true/false.
- If you are having trouble getting field names, right-click on the field then click ‘inspect’ to inspect the element.