URL API
Prefill information in Checkout using URL parameters.
Fundraise Up’s URL API allows you to pre-fill information in the Checkout modal, Campaign Page or Donation Form using URL parameters. This strategy works well if you are sending traffic to your site from an email marketing campaign and dynamically setting the value of parameters using merge tags.
Available parameters
| Parameter | Description | Example | Format |
|---|---|---|---|
firstName | Supporter's first name. Any content longer than 100 characters will be truncated. | Dawes | String |
lastName | Supporter's last name. Any content longer than 100 characters will be truncated. | Case | String |
email | Supporter's email address. | dawes.case@gmail.com | String |
amount | Donation Amount. By default, Fundraise Up doesn't automatically accept donations with cents (or other fractional currency units). However, you can enable this feature by contacting your personal Customer Success Manager or our Support Team. Learn more → | 150 | Float |
modifyAmount | Disallow the supporter to modify the donation amount set by the URL parameter amount. To lock the donation amount so that supporters cannot alter it, include the modifyAmount=no parameter in addition to the amount parameter with the specified sum. For example: amount=20&modifyAmount=no.
This parameter isn't applicable to the Donation Form. | no | String |
currency | Currency of the donation.
You must specify the currency by its ISO 4217 alphabetic code (for example, currency=USD for the US dollar).
The modifyAmount=no parameter also prohibits the donor from changing the currency value in the Checkout modal and Campaign page. | USD | String |
recurring | Sets the donation frequency. | once daily weekly biweekly every4weeks monthly bimonthly quarterly semiannual annual | String |
designationId | Sets a designation for the donation using the designation’s ID. | EHHJ9R36 | String |
modifyDesignation | Disallow the supporter to modify the designation set by the URL parameter, designationId.
If the designation is hidden in the Donation Form settings, designations passed through the URL will not appear on the Donation Form. However, they will appear in the checkout when it is opened from the Donation Form. | no | String |
tributeHonoree | Sets the value for the tribute honoree. If the tribute is hidden in the Donation Form settings, tributes passed through the URL will not appear on the Donation Form. However, they will appear in the checkout when it is opened from the Donation Form. Any content longer than 200 characters will be truncated. | Mom and Dad | String |
successUrl | Sets the redirect URL when a Thank you screen option in Checkout is set to “Redirect to URL”. This parameter isn't applicable to the Donation Form. | View example | String |
elementId | Element's ID. This parameter specifies which Donation Form on your website should be automatically filled in. If no matching Donation Form ID is found on the page, all parameters will be disregarded. You can find the Elements ID in your Dashboard. | XRHREBFG | String |
customFields | Additional custom fields that can be passed to the checkout for tracking purposes. | referralSource: Newsletter,
notes: Interested in volunteering | String |
_lang | The language displayed to the supporter during checkout. This must be an ISO language code for a language enabled in your account. | ar, da, de, en-CA, en-GB, en-US, es, fi, fr-CA, fr-FR, hu, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, zh-Hans, zh-Hant | String |
Best practices
For most use cases, we recommend that you do not use parameters that contain personally identifiable information (PII). PII is any information that can be used to identify an individual, such as a name, address, phone number, or e-mail address.
Examples
Below are two examples of URLs that have been appended with URL API parameters to pre-fill information in the Checkout form.
URL with PII
This example includes personally identifiable information such as the supporter’s first and last name, and their email address. Pre-filling this information streamlines the checkout process, but may affect compliance with your organization's or your service provider's privacy policies.
Donation Form
1https://ropsi.org/?elementId=XUWARWGG&firstName=Dawes&lastName=Case&email=dawes.case@gmail.com&amount=100&recurring=once&designationId=EHHJ9R36&modifyDesignation=yes&tributeHonoree=Mom%20and%20Dad¤cy=USDA link to a Donation Form with PII parameters in the URL.
PII submitted via URL will not be visible on the Donation Form, but will be displayed during checkout if accessed from the Donation Form.
Checkout modal
1https://ropsi.org?form=FUNCPJTZZQR&firstName=Dawes&lastName=Case&email=dawes.case@gmail.com&amount=100&modifyAmount=yes&recurring=once&designationId=EHHJ9R36&modifyDesignation=yes&tributeHonoree=Mom%20and%20Dad&fundraiseupLivemode=noA link to a Checkout modal with PII parameters in the URL.
Campaign Page
1https://donate.ropsi.org/page/DonateNow?fundraiseupLivemode=no&firstName=Dawes&lastName=Case&amount=100&modifyAmount=yes&recurring=once&tributeHonoree=Mom%20and%20Dad&_lang=en0US&_fundraiseup_country=USA link to a Campaign Page with PII parameters in the URL.
URL with no PII
This is the same URL as the example above, but the parameters containing personally identifiable information have been removed. If you are using analytics or advertising products, this is the best way to implement the URL API.
1https://ropsi.org?form=FUNCPJTZZQR&amount=100&modifyAmount=yes&recurring=once&designationId=EHHJ9R36&modifyDesignation=yes&fundraiseupLivemode=noIn the examples above, the parameter, fundraiseupLivemode=no, has been appended to the URL. This allows you to use test mode to explore the areas of Checkout where the URL API has pre-filled information.
customFields | Additional custom fields that can be passed to the checkout for tracking purposes. | referralSource: Newsletter,notes: Interested in volunteering | String |
Found a mistake? Is there a missing topic? Hard to read? Let us know