< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/emailBallotData (Jump to "Try It Now")

Required Parameters

Parameter name Value Description
voter_device_id string An 88 character unique identifier linked to a voter record on the server
api_key string (from post, cookie, or get (in that order)) The unique key provided to any organization using the WeVoteServer APIs
email_address_array string Array of Email address for self or friends to send the ballot link to.
first_name_array string Array of First Name for self or friends to send the ballot link to.
last_name_array string Array of Last Name for self or friends to send the ballot link to.
email_addresses_raw string Email addresses to send the ballot link to.
ballot_link string Ballot link to send.

Optional Parameters

Parameter name Value Description
invitation_message string An optional message to send.
sender_email_address string The email address to use if an email is not attached to voter account.

Response

{
  "status": string,
  "success": boolean,
  "description_of_send_status": string,
}

Response Status Codes

Code Description
VALID_VOTER_DEVICE_ID_MISSING Cannot proceed. A valid voter_device_id parameter was not included.
VALID_VOTER_ID_MISSING Cannot proceed. A valid voter_id was not found.

Try It Now: API Variables

Send current ballot link via email to self or friends.

Parameter name Value  
voter_device_id:
email_address_array:
first_name_array:
last_name_array:
email_addresses_raw:
ballot_link:
invitation_message:
sender_email_address:

(opens in new window)