Using URL API Parameters

You can control some of the checkout experience via the URL. Here is what you can do, and how.

The following are features and options that can be controlled via the URL:

Your core 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

 


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: