< back to index

HTTP request

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

Required Parameters

Parameter name Value Description
api_key string (from post, cookie, or get (in that order)) The unique key provided to any organization using the WeVoteServer APIs
voter_device_id string An 88 character unique identifier linked to a voter record on the server
kind_of_ballot_item string The kind of ballot item the voter wants to stop supporting. (kind_of_ballot_item is either "CANDIDATE", "POLITICIAN" or "MEASURE")
ballot_item_id integer The unique internal identifier of the ballot item the voter wants to stop supporting. (either ballot_item_id OR ballot_item_we_vote_id required -- not both. If it exists, ballot_item_id is used instead of ballot_item_we_vote_id)
ballot_item_we_vote_id string The unique identifier for this ballot_item across all networks (either ballot_item_id OR ballot_item_we_vote_id required -- not both. NOTE: In the future we might support other identifiers used in the industry.

Response

{
  "status": string (description of what happened),
  "success": boolean (did the save happen?),
  "ballot_item_id": integer,
  "ballot_item_we_vote_id": string,
  "kind_of_ballot_item": string (CANDIDATE, MEASURE),
}

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. Missing voter_id while trying to save.
UNABLE_TO_SAVE-CANDIDATE_ID_AND_MEASURE_ID_MISSING Cannot proceed. Neither candidate_id nor measure_id were included.
STOP_SUPPORTING_CANDIDATE STANCE_UPDATED Success. Existing entry updated.
STOP_SUPPORTING_CANDIDATE NEW_STANCE_SAVED Success. New entry created.
STOP_SUPPORTING_CANDIDATE STANCE_COULD_NOT_BE_UPDATED Cannot proceed. Existing entry could not be updated.
STOP_SUPPORTING_CANDIDATE NEW_STANCE_COULD_NOT_BE_SAVED Cannot proceed. New entry could not be created.
STOP_SUPPORTING_MEASURE STANCE_UPDATED Success. Existing entry updated.
STOP_SUPPORTING_MEASURE NEW_STANCE_SAVED Success. New entry created.
STOP_SUPPORTING_MEASURE STANCE_COULD_NOT_BE_UPDATED Cannot proceed. Existing entry could not be updated.
STOP_SUPPORTING_MEASURE NEW_STANCE_COULD_NOT_BE_SAVED Cannot proceed. New entry could not be created.

Try It Now: API Variables

Save or update an entry for the current voter for either a measure or candidate, so voter no longer supports. This does not mean that they oppose.

Parameter name Value  
voter_device_id:
kind_of_ballot_item:
ballot_item_id:
ballot_item_we_vote_id:

(opens in new window)