URL Shortcuts

This document lays out the specification of passing custom parameters into the form's donation page URL in order to pre-fill form fields.

URL Shortcut Parameters

Personal Information Parameters:

• first_name
• last_name
• address1
• address2
• city
• state
• zip
• company
• phone
• email

To pre-fill personal information fields, pass the fields and field values into the URL using a trailing "/v/" with field/value pairs comma delimited

The above example will prefill the first name and last name fields.

Donation Amount Parameters

• amount
• otherAmount

To pre-select a custom giving amount, add a trailing "/amount/[value]" to the URL. This structure will only work with active suggested amounts for the given form.

To pre-fill the "other amount", add a trailing "/amount/other/[value]" to the URL.

Restriction Parameters

• restriction
• subrestriction

To pre-select a restriction, add a trailing "/restriction/[name]" to the URL. This structure will only work with active restrictions for the given form.

To pre-select a subrestriction, add a trailing "restriction/[custom restriction name]/subrestriction/[name]" to the URL. This structure will only work with active subrestrictions under the selected restriction.

Event Parameters

• event

To pre-select an event, add a trailing "/event/[event ID]" to the URL. This structure will only work with active events for the given form.

Pledge Parameters

• pledge

To pre-select a pledge, add a trailing "/pledge/[pledge ID]" to the URL. This structure will only work with active pledges for the given form.

Recurring Frequency Parameters (New Forms ONLY)

• frequency

To pre-select a recurring frequency, add a trailing "/frequency/[frequency letter]" to the URL. This structure will only work with active recurring frequencies for the given form.

Possible frequency letters are:

• w for Weekly
• b for Every Other Week
• m for Monthly
• q for Quarterly
• s for Semiannually
• a for Annually

Internal Parameters

• info

To add associated info to a transaction, add a trailing "/info/[data]" to the URL. This information will NOT be visible to the donor, but will store the associative data for the transaction upon submission.

Stacked Parameters

URL parameters can be stacked to pre-fill and/or pre-select multiple fields

In the above example, the Test Restriction restriction will be pre-selected, the 50.00 custom amount will be pre-selected, and the first/last name fields will be pre-filled.

* denotes a required field

** denotes a required field based on Event settings

*** denotes a field that is only required when submitting Form level API credentials