URL API

Add parameters to donation links to automatically fill checkout information.

Use Fundraise Up's URL API to create donation links that automatically fill in supporter and donation details when opened. This can make giving faster, increase conversions, and help you personalize the experience — especially in email campaigns, SMS outreach, and digital ads.

Available parameters

 
Link copied

Each parameter adds specific information to your donation forms. Add them to your URLs using the format shown above. The order of parameters doesn't affect functionality.

ParameterDescriptionExample
amountDonation amount. Fundraise Up doesn't accept donations with cents (or other fractional currency units) by default. Contact us to enable fractional amounts.amount=150
currencyCurrency for the donation using ISO 4217 codes (USD for US dollars, EUR for euros). Combine with modifyAmount=no to prevent supporters from changing the currency.currency=USD
designationIdSets a donation designation using the designation's ID from your Dashboard.designationId=EHHJ9R36
elementIdSpecifies which Donation Form to fill. Find your Donation Form ID in the Dashboard under Elements.elementId=XRHREBFG
emailSupporter's email address.email=alex.garcia@example.com
firstNameSupporter's first name. Content longer than 100 characters gets truncated.firstName=Alex
lastNameSupporter's last name. Content longer than 100 characters gets truncated.lastName=Garcia
modifyAmountPrevents supporters from changing the prefilled amount. Set to no to lock the amount. Not available for Donation Forms. If the prefilled amount is empty, zero, or below the campaign’s minimum amount, this parameter is ignored and the amount becomes editable.modifyAmount=no
modifyDesignationPrevents supporters from changing the prefilled designation. Set to no to lock the designation.modifyDesignation=no
recurringSets donation frequency. Available options: once, daily, weekly, biweekly, every4weeks, monthly, bimonthly, quarterly, semiannual, annual.recurring=monthly
successUrlSets redirect URL instead of Fundraise Up’s default Thank you screen when Checkout Modal or Campaign Page is set to "Redirect to URL". Not available for Donation Forms. See example of the custom Thank you screen.successUrl=https://example.com/thank-you
tributeHonoreeSets the tribute honoree name. Content longer than 200 characters gets truncated. Use %20 for spaces in URLs.tributeHonoree=Mom%20and%20Dad
_langLanguage for the checkout experience using ISO language codes for languages enabled in your account. Available options: ar, da, de, en-CA, en-GB, en-US, es, es-US, fi, fr-CA, fr-FR, hu, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, zh-CN, zh-TW._lang=en-US
Parameters are case-sensitive. Copy parameter names exactly as shown in the table above.

Privacy considerations

 
Link copied

Think carefully before including personally identifiable information (PII) in your URLs. PII includes names, addresses, phone numbers, and email addresses. While prefilling this information improves the supporter experience, it can create privacy and compliance issues.

Google's marketing tools (Ads and Analytics) prohibit PII in URLs. If you use these services, avoid parameters like firstName, lastName, and email. Learn more about Google's PII policies.

For most campaigns, focus on donation-specific parameters like amount, recurring, and designationId rather than personal information. Use personalized links in direct emails, newsletters, or messages to known supporters, but remove personal details for public campaigns.

Implementation methods

 
Link copied

The URL API works with three different Fundraise Up donation experiences: Checkout Modal, Campaign Page and Donation Form element.

You can also combine the URL API with the Donate Link element. After creating this element in the Dashboard, you can add additional parameters to the generated URLs.

Checkout Modal

 
Link copied

The Checkout Modal is an overlay that appears on top of your website content, allowing supporters to donate without leaving the current page.

Campaign Page

 
Link copied

Campaign Pages are dedicated donation landing pages hosted by Fundraise Up, featuring customizable content alongside the checkout form.

Donation Form

 
Link copied

The Donation Form embeds your checkout form directly within your webpage layout, rather than opening as an overlay.

To use URL parameters with Donation Forms, the URL must include the form’s elementId. If the elementId is missing or doesn’t match any element on the page, other parameters will be ignored.

Personal information submitted through URLs won't appear on the Donation Form itself, but will display during checkout when accessed from the form.

https://ropsi.org/?elementId=XUWARWGG&firstName=Alex&lastName=Garcia&email=alex.garcia@example.com&amount=100&recurring=once&designationId=EHHJ9R36&tributeHonoree=Mom and Dad&currency=USD

Click this link to see a demo campaign and how the parameters work. Scroll the page to the "Help stop the refugee crisis" section to see the Donation Form.

Locking donation details

 
Link copied

You can prevent supporters from changing prefilled amount or designation by using the modify parameters. This works well for specific initiatives or membership programs where you want to control the donation experience.

Fixed amount example:

https://ropsi.org/?form=FUNCPJTZZQR&amount=20&modifyAmount=no&currency=USD&recurring=once

This link sets a $20 one-time donation that supporters cannot change. Click the link to see a demo campaign and how the parameters work.

Fixed designation example:

https://ropsi.org/?form=FUNCPJTZZQR&designationId=EXVNFMNX&modifyDesignation=no&amount=150&currency=USD

This link preselects a specific fund and prevents supporters from choosing a different designation. Find designation IDs in your Dashboard under Settings > Designations.

If the prefilled donation amount is invalid — for example, it’s 0, missing, outside the allowed minimum or maximum, or uses fractional units not permitted for the account — the modifyAmount=no parameter is ignored. In those cases, the amount becomes editable so the supporter can complete the donation.

Using custom fields with URL API

 
Link copied

You can also use Fundraise Up’s custom fields with the URL API to pass additional values along with donation parameters. This is helpful for tracking traffic sources, partner IDs, membership numbers, or any other context-specific data.

Before using a custom field in your URL, you need to create it in your campaign’s settings in the Dashboard. The field name in the URL must exactly match the name of the custom field you create.

How to create custom fields for a campaign

Once the field exists in the Dashboard, you can use it like any other URL parameter:

  • Add them to your base donation link using the same ? and & syntax.
  • Values can be up to 200 characters and should replace spaces with %20 for proper URL encoding.
  • You define both the field name (created in the Dashboard) and the value you want to record.

For example, if you’ve created a custom field called traffic_channel for your campaign, you can include it in the URL like this:

https://ropsi.org/?form=FUNCPJTZZQR&amount=50&currency=USD&traffic_channel=smm

When a supporter donates using this link, the value smm will be recorded for the traffic_channel custom field.

You can combine custom fields with regular URL API parameters:

Custom field values won’t always remain visible in the supporter’s browser URL. This is normal. They will still be recorded in the Dashboard and available for exports or integrations.

You can later view these custom field values:

  • On individual donation records in the Donations tab of your Dashboard (scroll to Custom fields section).
  • In exports, where they appear as additional columns.
  • In integration mappings to CRMs or analytics tools.

Test your setup

 
Link copied

Add fundraiseupLivemode=no to any URL to test your parameters without processing real donations. This lets you verify that information appears correctly before launching your campaign.

 

In this article