Using URL API Parameters

Fundraise Up's URL API allows advanced users to programmatically make links that open checkout with certain conditions applied.

Fundraise Up offers an in-dashboard link builder, which you can use by going to the Elements tab and choosing to make either a Donate Link or a P2P Link. The resultant Element will give you a URL that, when people visit it, will open either donation checkout or the P2P signup experience.

Sometimes, the Donate Link Element might not be enough. For example, you might be writing a piece of Javascript that allows people to make selections to how they should start their donation. In cases like those, you can use our URL API to generate those links on the fly, instead of pre-composing them from the Element editor. 

When you are composing your own custom web address instead of using a Donate Link Element, you can apply the following URL parameters to control the checkout experience:

The base of your URL will typically look something like this:

https://website.org/?form=FUNXXXX

Where FUNXXXX is your Campaign ID (Form ID)

By adding any number of the following parameters, you can control various options.

All parameters are case-sensitive. For example, DesignationID will not work for designationId

First Name, Last Name, and Email address, separate and together, can constitute personally identifiable information and their usage can be subject to regulation. This is especially true when visitors' URLs are saved by third-party services with their own terms and conditions like Google Analytics or browser extensions.

We recommend determining whether the use of the First Name, Last Name, and Email parameters is safe for your own use case prior to making use of those parameters.


firstName=[string]

The email address that would appear in their Personal Information, pre-filled. The donor can change it before completing donation checkout.

Example: https://website.org?form=FUNXXXX&firstName=Selena

With the following result:

Screen Shot 2021-03-22 at 9.28.15 AM


lastName=[string]

The email address that would appear in their Personal Information, pre-filled. The donor can change it before completing donation checkout.

Example: https://website.org?form=FUNXXXX&lastName=Montalbán

With the following result:

Screen Shot 2021-03-22 at 9.30.22 AM


email=[string]

The email address that would appear in their Personal Information, pre-filled. The donor can change it before completing donation checkout.

Example: https://website.org?form=FUNXXXX&email=smont@demo.com

With the following result:

Screen Shot 2021-03-22 at 9.31.15 AM


amount=[whole_number]

The amount that would appear in the box, prefilled. This will override any AI/machine learning recommendation for that box, while allow AI to populate the suggested amount button array.

Example: https://website.org/?form=FUNXXXX&amount=50

With the following result:

 


modifyAmount=no

This must accompany the amount parameter. This would disable the ability to change the amount from that specific link. Particularly useful for specific amount asks, incentives (e.g. $10 gets a poster), amount-asks in emails, etc.

Example: https://website.org/?form=FUNXXXX&amount=100&modifyAmount=no

With the following result:

 


recurring=once/monthly

Your campaign forms have a default state of ONCE or MONTHLY when they open, as per your campaign checkout settings. However, if you wish to open the checkout with the other (non-default) option you can do that. This would allow you to test results of starting the donation form with monthly, or one-time, as different organizations have seen different financial-impact results. Sometimes Monthly as default earns more monthly donors but lower average sizes. Or, fewer monthly donors but larger one-time give average gift sizes. 

Example: https://website.org/?form=FUNXXXX&recurring=monthly

 With the following result:

 


designationId=EXXXXX

If your checkout has multiple designations, and you'd like to pre-select a designation that is not the default, you can do this with. You would simply find the designation ID in the dashboard under Designations and use this in the URL string.

Example: https://website.org/?form=FUNXXXX&designationId=EXXXXX

With the following results: