URL API
Easily pre-fill information in Checkout using URL parameters
Prefill intake data in Checkout using specific URL parameters.
Found an error? Missing a topic? Difficult to understand? Let us know
Givetly’s URL API lets you inject predefined data into the Checkout modal, or Donation Form using URL parameters. This approach is particularly beneficial for driving traffic from email campaigns by dynamically adjusting parameter values through merge tags.
Available Parameters
Here’s a list of the available URL parameters:
| Parameter | Description | Example | Format |
|---|---|---|---|
firstName | Supporter’s first name. Content longer than 100 characters will be truncated. | Dawes | String |
lastName | Supporter’s last name. Content longer than 100 characters will be truncated. | Case | String |
email | Supporter’s email address. | [email protected] | String |
amount | Donation amount. By default, Givetly doesn’t process donations involving fractional currency units. Contact support to enable this feature. Learn more | 150 | Float |
modifyAmount | Prohibits the supporter from changing the donation amount set by amount parameter. E.g., amount=20&modifyAmount=no. | no | String |
currency | Currency of the donation, specified by its ISO 4217 alphabetic code (e.g., currency=USD for US dollars). | USD | String |
recurring | Sets the donation frequency. | once | String |
designationId | Designation for the donation using the designation’s ID. | EHHJ9R36 | String |
modifyDesignation | Prohibits the supporter from altering the designation set by designationId. | no | String |
tributeHonoree | Sets tribute honoree. Content longer than 200 characters will be truncated. | Mom and Dad | String |
successUrl | Redirect URL upon a successful donation when the Thank you screen option in Checkout is set to “Redirect to URL”. | Example | String |
elementKey | Element’s ID for specifying which Donation Form to auto-fill. All parameters will be ignored if no matching ID is found. Find Element ID in your Dashboard. | XRHREBFG | String |
Best Practices
We strongly recommend avoiding parameters containing personally identifiable information (PII) in most use cases. PII includes name, address, phone number, or e-mail address.
Examples
Below are a couple of examples where URL API parameters are used to pre-populate data in the Checkout form.
URL with PII
This example includes personal details like the supporter’s first and last name, and email. While it simplifies the checkout, it may conflict with privacy policies.
Donation Form
A link to a Donation Form pre-filled with PII.
PII submitted via URL will only appear during checkout if accessed from the Donation Form.
Checkout modal
A link to a Checkout modal with PII in the URL.
URL with no PII
This example is the same as above but without PII, which is optimal for using analytics or advertising solutions.
In the examples above, the parameter givetlyLivemode=no has been appended. This allows you to use test mode to preview Checkout areas where URL API has prefilled data.