Search

TurboVote Page Query Parameters

  • Updated

Query parameters are a defined set of parameters (key-value pair) attached to the end of a URL used to provide additional information to a web server when making requests. They are an important part of the URL that define specific content or actions based on the data being passed.

TurboVote uses query parameters to

  • shape the TurboVote tool or guide experience e.g. what language to show by default /&lang=es 
  • pass along
    • data to populate form fields or search queries
    • referral codes &r=springcampaign and metadata to associate with user accounts created on sign-up
  • set embed-specific instructions e.g. /?embed=window&partner=01gzpamk4zqm16ts3yjxt668tk&placement=vote-hub
  • transport page paths and query parameters to override default SRC value in live TurboVote embeds

Query Parameters that Shape TurboVote User Experience

Language

lang sets the language used throughout the TurboVote experience.

Optional. If absent, TurboVote renders in English by default. Learn more about multi-language support in TurboVote.

The following values are supported:

Value Impact Destination Site Example Embed Example
en Shows page in English by default https://example.turbovote.org/?lang=en https://demoturbovote.org/example?tv-lang=en
es Shows page in Spanish by default https://example.turbovote.org/?lang=es https://demoturbovote.org/example?tv-lang=es  
 am  Shows page in Amharic by default https://example.turbovote.org/?lang=am https://demoturbovote.org/example?tv-lang=am  
 hy  Shows page in Armenian by default https://example.turbovote.org/?lang=hy https://demoturbovote.org/example?tv-lang=hy  
 bn  Shows page in Bengali by default https://example.turbovote.org/?lang=bn https://demoturbovote.org/example?tv-lang=bn 
 zh-CN  Shows page in Simplified Chinese by default https://example.turbovote.org/?lang=zh-CN https://demoturbovote.org/example?tv-lang=zh-CN 
 zh-TW  Shows page in Traditional Chinese by default https://example.turbovote.org/?lang=zh-TW https://demoturbovote.org/example?tv-lang=zh-TW 
 ht  Shows page in Creole by default https://example.turbovote.org/?lang=ht https://demoturbovote.org/example?tv-lang=ht 
 fr  Shows page in French by default https://example.turbovote.org/?lang=fr https://demoturbovote.org/example?tv-lang=fr 
 de  Shows page in German by default https://example.turbovote.org/?lang=de https://demoturbovote.org/example?tv-lang=de 
 el  Shows page in Greek by default https://example.turbovote.org/?lang=el  https://demoturbovote.org/example?tv-lang=el 
 hi  Shows page in Hindi by default https://example.turbovote.org/?lang=hi https://demoturbovote.org/example?tv-lang=hi 
 id  Shows page in Indonesian by default https://example.turbovote.org/?lang=id https://demoturbovote.org/example?tv-lang=id 
 it  Shows page in Italian by default https://example.turbovote.org/?lang=it  https://demoturbovote.org/example?tv-lang=it 
 ja  Shows page in Japanese by default https://example.turbovote.org/?lang=ja  https://demoturbovote.org/example?tv-lang=ja 
 km  Shows page in Khmer by default https://example.turbovote.org/?lang=km https://demoturbovote.org/example?tv-lang=km 
 ko  Shows page in Korean by default https://example.turbovote.org/?lang=ko https://demoturbovote.org/example?tv-lang=ko 
 pl  Shows page in Polish by default https://example.turbovote.org/?lang=pl https://demoturbovote.org/example?tv-lang=pl 
 pt-BR  Shows page in Portuguese (Brazil) by default https://example.turbovote.org/?lang=pt-BR https://demoturbovote.org/example?tv-lang=pt-BR 
 pt  Shows page in Portuguese (Portugal) by  default https://example.turbovote.org/?lang=pt https://demoturbovote.org/example?tv-lang=pt 
 pa  Shows page in Punjabi by default https://example.turbovote.org/?lang=pa https://demoturbovote.org/example?tv-lang=pa 
 ru  Shows page in Russian by default https://example.turbovote.org/?lang=ru https://demoturbovote.org/example?tv-lang=ru 
 so  Shows page in Somali by default https://example.turbovote.org/?lang=so https://demoturbovote.org/example?tv-lang=so 
 fil  Shows page in Tagalog by default https://example.turbovote.org/?lang=fil https://demoturbovote.org/example?tv-lang=fil 
 uk  Shows page in Ukrainian by default https://example.turbovote.org/?lang=uk  https://demoturbovote.org/example?tv-lang=uk 
 vi  Shows page in Vietnamese by default https://example.turbovote.org/?lang=vi https://demoturbovote.org/example?tv-lang=vi 

 

Query Parameters that Pass Along Data

Form Fields & Search Queries

Field Notes

Pre-populate Fields: Adult Tools

Reminders, Register to Vote, Check Your Registration and Election Search

Pre-populate Fields: Youth Tools

Preregistration

 Election Search Queries Voting Information Project Web Widget
email   ✅ ✅    
sms   ✅ ✅    
first-name   ✅ ✅    
middle-name   ✅ ✅    
last-name   ✅ ✅    
preferred-name Maps to Use a different name when messaging me option on all TurboVote account sign-up forms ✅ ✅    
birth-date

Accepts either
 

  • US Month-Day-Year with leading zeros (mm-dd-yyyy) or
  • ISO (yyyy-mm-dd) date formats
 ✅ ✅    
street   ✅ ✅ ✅  
street2   ✅ ✅ ✅  
city   ✅ ✅ ✅  
state Two letter state abbreviation e.g. NY ✅ ✅ ✅  
zip United States 5-digit Postal Code e.g. 10001 ✅ ✅ ✅  
zip4 United States Postal ZIP+4® ZIP Code™ number e.g. 10001 ✅ ✅ ✅  
address Single string including street+ street2+ city+ state+ zip+ passed along to show users where to vote in the Voting Information Project Web Widget on TurboVote Election Guides       ✅

 

Account Association

Referral Code

r passes along a TurboVote Referral Code created to track accounts created if you choose to embed TurboVote on a page or site dedicated to a specific campaign. Optional.

Value Impact URL Example Embed Example
r Associates TurboVote Referral Code with any sign-up made in session after initial navigation to URL https://example.turbovote.org/?r=springcampaign https://demoturbovote.org/example?tv-r=springcampaign

 

Metadata

See Associating Metadata with TurboVote Accounts

Embed-Specific Parameters

Embed Type

embed sets the type of web page to render. Currently, window is the only value accepted and it’s required.

partner

partner passes along your unique numeric TurboVote partner ID partner which is required for TurboVote to render the embedded web experience on your site.

After consulting with our Partnerships team, you’ll be provided with embed codes that include this partner ID.

Embed Placement Referral Code

placement passes along a name or number used to reference where on your site the embed is integrated.

While optional, the embed codes provided by your partner manager will set the placement parameter using a term that references the landing page, tool or guide being embedded e.g. Election Reminders sign-up embed code will set placement parameter to “reminders-".

Work with your partner manager to append any existing placement IDs your site employs or to explore ways to leverage this flexible parameter.