< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/pledgeToVoteWithVoterGuide (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
voter_guide_we_vote_id string Pledge to support or oppose all of the things listed on this voter guide
delete_pledge boolean Remove this pledge
api_key string (from post, cookie, or get (in that order)) The unique key provided to any organization using the WeVoteServer APIs

Response

{
  "status": string,
  "success": boolean,
  "voter_device_id": string (88 characters long),
  "organization_we_vote_id": string,
  "voter_guide_we_vote_id": string,
  "google_civic_election_id": integer,
  "pledge_statistics_found": boolean,
  "pledge_goal": integer,
  "pledge_count": integer,
  "voter_has_pledged": boolean,
  "delete_pledge": boolean,
}

Response Status Codes

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

Try It Now: API Variables

Call this to save that the voter is pledging to vote as the voter guide recommends.

Parameter name Value  
voter_device_id:
voter_guide_we_vote_id:
delete_pledge: True
False

(opens in new window)