< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterGuideSave (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

Optional Parameters

Parameter name Value Description
voter_guide_we_vote_id string The unique identifier for this voter guide. If not passed in, create a new voter guide for this voter's linked_organization_we_vote_id for this election.
google_civic_election_id integer

Response

{
  "status": string,
  "success": boolean,
  "voter_guide_display_name": string (Name of this org or person),
  "voter_guide_owner_type": ORGANIZATION, PUBLIC_FIGURE, VOTER),
  "we_vote_id": string (We Vote ID of the voter guide),
  "organization_we_vote_id": string (We Vote ID for the org that owns the voter guide),
  "public_figure_we_vote_id": string (We Vote ID for the person that owns the voter guide),
  "voter_guide_image_url_large": string (We Vote ID for the person that owns the voter guide),
  "voter_guide_image_url_medium": string (We Vote ID for the person that owns the voter guide),
  "voter_guide_image_url_tiny": string (We Vote ID for the person that owns the voter guide),
  "last_updated": string (time in this format %Y-%m-%d %H:%M),
  "google_civic_election_id": integer,
  "twitter_description": string,
  "twitter_followers_count": integer,
  "twitter_handle": integer,
}

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

Save a new voter guide.

Parameter name Value  
voter_device_id:
voter_guide_we_vote_id:
google_civic_election_id:

(opens in new window)