< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterGuidePossibilitySave (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
voter_guide_possibility_id integer The id of the voterGuidePossibility to be saved.

Optional Parameters

Parameter name Value Description
candidates_missing_from_we_vote boolean Are there candidates endorsed on this page that we do not have in our Candidate table?
capture_detailed_comments boolean Are there comments that go along with endorsements that remain to be captured?
clear_organization_options boolean Is the organization this endorsement linked to incorrect, that should be unlinked?
contributor_comments string Comments from the person saving this VoterGuidePossibility.
contributor_email string The email address (unverified) of the person submitting this VoterGuidePossibility.
hide_from_active_review boolean We are done reviewing and processing this VoterGuidePossibility.
ignore_this_source boolean This web page does not have endorsements and should be ignored.
internal_notes string Internal notes from a We Vote political data manager.
organization_we_vote_id string The we_vote_id of the organization making these endorsements.
possible_organization_name string The name of the organization making these endorsements, for possible matching with organization in We Vote database.
limit_to_this_state_code string All of these endorsements relate to candidates or ballot items in this state.
possible_organization_twitter_handle string The Twitter handle of the organization making these endorsements, for possible matching with organization in We Vote database.

Response

{
  "status": string,
  "success": boolean,
  "candidates_missing_from_we_vote": boolean,
  "cannot_find_endorsements": boolean,
  "capture_detailed_comments": boolean,
  "contributor_comments": string,
  "contributor_email": string,
  "hide_from_active_review": boolean,
  "ignore_this_source": boolean,
  "internal_notes": string,
  "possible_organization_name": string,
  "possible_organization_twitter_handle": string,
  "limit_to_this_state_code": string,
  "url_to_scan": string,
  "voter_device_id": string (88 characters long),
  "voter_guide_possibility_edit": string,
  "voter_guide_possibility_id": integer,
  "organization": dict
   {
     "organization_we_vote_id": string,
     "organization_name": string,
     "organization_website": string,
     "organization_twitter_handle": string,
     "organization_email": string,
     "organization_facebook": string,
     "we_vote_hosted_profile_image_url_medium": string,
     "we_vote_hosted_profile_image_url_tiny": 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.
VOTER_GUIDE_POSSIBILITY_SAVED URL saved.

Try It Now: API Variables

Update existing VoterGuidePossibility with altered data.

Parameter name Value  
voter_device_id:
voter_guide_possibility_id:
candidates_missing_from_we_vote: True
False
capture_detailed_comments: True
False
clear_organization_options: True
False
contributor_comments:
contributor_email:
hide_from_active_review: True
False
ignore_this_source: True
False
internal_notes:
organization_we_vote_id:
possible_organization_name:
limit_to_this_state_code:
possible_organization_twitter_handle:

(opens in new window)