Parameters

Parameters let you pass designations, appeals, and campaigns through a donation form without adding them to the form's configuration. For example, if there are too many designations to add to a form, insert the parameter into the hosted URL for each designation you want to pass through the form.

The parameters you can add to the end of the form's URL are,

  • desid for the designation ID.

  • desname for the name of the designation. This is helpful if you want a donor-friendly designation name on the form. Otherwise, the designation won't be visible to donors.

    Note: Only available for Standard Donation Forms.

  • appealid for the appeal ID.

  • campaignid for the campaign ID.

    Note: Only available for Standard Donation Forms.

Find IDs

To find the ID of each parameter, navigate to Online Giving in the service menu.

  1. From All donation forms, select the form.

  2. Select Edit form.

  3. From Get started, find the IDs for the parameters you want to use.

    • For designations, select Show all under Designation for gifts. Find the designation and make note of the ID.

    • For campaigns, under Hidden fields, Campaign, enter the campaign's name. Find the campaign and make note of the ID.

    • For appeals, under Hidden fields, Appeal,enter the appeals' name. Find the appeal and make note of the ID.

  4. Select Cancel to close.

  1. From All donation forms, select the form.

  2. Select Edit form.

  3. To find the designation IDs, from Donation, Designations, select Show all. Enter the designation name and make note of the ID.

  4. To find the appeal IDs, from Optional fields, Hidden fields, enter the appeal name. Make note of the ID.

  5. Select Cancel to close.

Add parameter to a form's hosted URL

Donation forms have hosted URLs you can use to direct donors to your forms if you are unable to host them on your organization's website. To add a parameter, navigate to Online Giving in the solution menu.

Note: Designation name and campaign ID are only available for Standard Donation Forms.

  1. From All donation forms, select the form.

  2. Under Publish, select Launch form from its URL and copy the URL.

    Tip: For an Optimized Form, select Hosted URL.

  3. Associate the form with the parameters,

    • For a designation, add &desid=ID to the end of the URL. Replace "ID" with the designation's ID. For example,

      https://www.bb.com/donor-form?svcid=renxt&formId=8aa3b1c7-e4ad-4ee5-adff-e40efa81aae8&envid=t-Z-FEhKwLvkGVGjTCcbBMEA&zone=usa&desid=48923

      Additionally, if you want to display the designation's name on a Standard Donation Form, add &desname=Name after &desid=ID. Replace "Name" with the appropriate name for the designation. For example, https://www.bb.com/donor-form?svcid=renxt&formId=8aa3b1c7-e4ad-4ee5-adff-e40efa81aae8&envid=t-Z-FEhKwLvkGVGjTCcbBMEA&zone=usa&desid=48923&desname=2023 General Fund

      Tip: The designation name isn't associated with the gift, but it lets you to use donor-friendly names when your designations have a naming convention, such as 2023-GenFund. Additionally, if the name you use has spaces those are automatically replaced with %20 when you use the URL.

    • For an appeal, add appealid=ID to the end of the URL. Replace "ID" with the appeal's ID. For example, https://host.nxt.blackbaud.com/adaptive-donor-form?formId=86a0c128-4364-460a-baff-5bddb1c7f3b5&envid=t-Z-FEhKwLvkGVGjTCcbBMEA&zone=usa&appealid=5

    • For a campaign, add campaignid to the end of the URL of a Standard Donation Form Replace "ID" with the campaign's ID. For example, https://www.bb.com/donor-form?svcid=renxt&formId=8aa3b1c7-e4ad-4ee5-adff-e40efa81aae8&envid=t-Z-FEhKwLvkGVGjTCcbBMEA&zone=usa&campaignid=92

Add parameter to an Optimized Form's hyperlinks

After you have the IDs you need and the Optimized Loader Script is on your website, you can launch your form with a designation and appeal. To add a parameter, navigate to Online Giving in the service menu.

  1. From All donation forms, select the form.

  2. Under Publish, select Copy from Hyperlinks, Open form on top of same webpage.

  3. To associate the form with a designation, add &desid=ID to the end of the hyperlink. Replace "ID" with the designation's ID. For example,

    <a href="?bbFormId=22c45fbe-bef6-45c5-b345-f48671654671&desid=2">Donate</a>

  4. To associate the form with an appeal, add &appealid=ID to the end of the hyperlink. Replace "ID" with the appeal's ID. For example, <a href="?bbFormId=22c45fbe-bef6-45c5-b345-f48671654671&desid=2&appealid=5">Donate</a>

  1. From All donation forms, select the form.

  2. Under Publish, select Copy from Hyperlinks, Open form from other webpages or emails.

  3. Change https://yourwebsite.org to your organization's website.

    Note: If your hyperlink already has a question mark, use an ampersand ("&") before bbFormID.

  4. To associate the form with a designation, add &desid=ID to the end of the hyperlink. Replace "ID" with the designation's ID. For example,

    <a href="https://fresh-air.org?bbFormId=22c45fbe-bef6-45c5-b345-f48671654671&desid=2">Donate</a>

  5. To associate the form with an appeal, add &appealid=ID to the end of the hyperlink. Replace "ID" with the appeal's ID. For example, <a href="https://fresh-air.org?bbFormId=22c45fbe-bef6-45c5-b345-f48671654671&desid=2&appealid=5">Donate</a>