URL API

Prefill information in Checkout using URL parameters

Fundraise Up’s URL API enables you to prefill information in Checkout using URL parameters. This approach is useful when you are sending traffic to your website from an email marketing campaign and can dynamically set the value of parameters using merge tags.

The URL API may be used in conjunction with the Donate Link Elements component to create highly-customizable tracking links.

Available parameters

Parameter Format Example Description
firstName String Dawes The first name of the donor
lastName String Case The last name of the donor
email String dawes.case@gmail.com The email address of the donor
amount Integer 100 The donation amount expressed as a whole number
modifyAmount Boolean (yes/no) yes Allow or disallow the donor to modify the donation amount set by the URL parameter, amount
recurring String (once/monthly) once Sets the donation frequency
designationId String EHHJ9R36 Set a designation for the donation using the designation’s ID
modifyDesignation Boolean (yes/no) yes Allow or disallow the donor to modify the designation set by the URL parameter, designationId
tributeHonoree String Mom and Dad Sets the value for the tribute honoree
successUrl String View example Sets the redirect URL when a Thank you screen option in Checkout is set to “Redirect to URL”
URL parameters are case sensitive. Reference the table above for properly formatted parameter names.

Best practices

For most use cases, we recommend not using parameters that include personally identifiable information (PII). PII is any data that can be used to identify an individual, such as a name, address, phone number, or email address.

If you are using marketing tools from Google, such as Ads or Analytics, you should not use URL API parameters that include PII, as the practice goes against Google’s policies. Learn more →

Examples

Below are two examples of URLs that have been appended with URL API parameters to prefill information in Checkout:

URL with name and email address

This example include personally identifiable information such as the supporter’s first and last name, and their email address. Prefilling this information streamlines the checkout process, but may affect compliance with your organization’s privacy policies or the polices of its service providers.

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=no

URL with no PII

This is the same URL as the example above, but parameters with personally identifiable information have been removed. If you are using analytics or ads products, this is the best approach to implementing the URL API.

1https://ropsi.org?form=FUNCPJTZZQR&amount=100&modifyAmount=yes&recurring=once&designationId=EHHJ9R36&modifyDesignation=yes&fundraiseupLivemode=no

In the examples above, the parameter, fundraiseupLivemode=no, has been appended to the URL. This enables you to use test mode to explore the areas of Checkout where the URL API has prefilled information.

 

In this article