URL Parameters
Learn how URL Parameters allow data to be passed from a link directly into an Action Page or Callback URL, automatically populating form fields based on the values provided.
URL Parameters allow data to be passed directly from a URL into an Action Page. When applied, the specified values automatically populate the corresponding form fields.
URL Parameters can also be added to Callback URLs, which replace the confirmation message and redirect supporters after a successful submission.
Example with URL Parameters:
https://secure.anedot-sandbox.com/city-food-pantry/donate?amount=25&city=New+Orleans&email=annadote%40anedot.com&employer=Anedot&first_name=Anna&last_name=Dote&occupation=Support&phone=2252501301&state=LA&street=123+Test+St&zip=70808
In this example, each parameter (amount
, city
, email
, etc.) corresponds to a field in the Action Page, and the provided value will prefill that field.
Formatting Rules
-
Start parameters with a
?
after the base page URL. -
Separate each parameter with an
&
. -
Use
+
for spaces and%40
for the@
symbol (or other URL encoding as needed).
Available URL Parameters
Below is a list of available URL Parameters that are available for use with Action Pages:
- actblue_order_number
- amount (
100
* - whole number without cents to choose default amount)* - amounts (
10,25,50,100,250
* - number separated list )* - city
- country
- election_cycle (NationBuilder)
- election_period (NationBuilder)
- election_period_ngp_code (NationBuilder)
- embed
- employer_name
- express_checkout_method (must be followed with one of the following:
applepay
,googlepay
,paypal
) - first_name
- frequency (for commitments)
- fund_ids (separated by %)
- is_private (NationBuilder)
- lang=es (translates the form language to Spanish)
- last_name
- line_1
- line_2
- membership_name (NationBuilder)
- middle_name
- note (NationBuilder)
- occupation
- phone
- postal_code
- recruiter_name_or_email (NationBuilder)
- referrer_to_form
- region (only accepts 2-digit state abbreviations; e.g.
LA
forLouisiana
) - sc
- source_code
- suffix
- state (accepts state abbreviation; e.g.
LA
notLouisiana
) - street
- street_2
- title
- tracking_code_slug (NationBuilder)
- ucampaign_token
- utm_campaign
- utm_content
- utm_medium
- utm_source
- utm_term
- zip
The following aliases are also available for URL parameters:
- sc = source_code
- street = line_1
- street_2 = line_2
- zip = postal_code
- state = region
Languages and Translations
Adding ?lang=es
to the end of an Action Page URL will automatically translate the standard page content into Spanish.
Any custom field content must be manually translated and saved within the Form tab of the Builder.
Custom Field Parameters
Custom Field URL parameters are defined by the Internal Name assigned in Action Pages.
To find the Internal Name for a custom field:
-
In the Page Builder, open the Form tab.
-
Access the Field Preset editor.
-
Click the Pencil icon next to the custom field.
-
The Internal Name will appear below the Field Name.
For Hidden Fields, the Internal Name is referred to as the Key.
Example: A hidden field with the Internal Name hidden_custom_field
would be applied as:
anedot.com/donate?hidden_custom_field=special
NationBuilder fields must be created as hidden custom fields to work with URL parameters.
URL Parameters for Callback URLs
Action Page Callback URLs can utilize tokens to retrieve data. Simply reference the token/parameter in the Callback URL using the double curly bracket format below:
address_line_1
address_line_2
(can contain one ID for single fund APs or a comma-separated list of IDs for multi-fund APs)
- Note: List order matches ID order for donation_ids_
(can contain one status for single fund APs or a comma-separated list of statuses for multi-fund APs)
(@ replaced with %40 in the URL)
Custom field values are also available by using the field's internal name as both the key and a token (when placed in double curly brackets).
Check out the following example Callback URL containing URL Parameters:
https://[fakewebsite].com?city\=address_city&country=address_country&address_line_1=address_line_1&address_line_2=address_line_2&zip=address_postal_code&state=address_region&email=email&employer_name=employer_name&donation_ids=donation_ids&donation_statuses=donation_statuses&fees=fees&first_name=first_name&last_name=last_name&occupation=occupation&payment_method=payment_method&payment_method_last_digits=payment_method_last_digits&phone=phone&recurring=recurring&recurring_frequency=recurring_frequency&total_amount=total_amount&custom1=custom1