< back to index

HTTP request

get https://api.wevoteusa.org/apis/v1/voterContactSave (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.
email_address_text string The email of the VoterContactEmail that we want to alter.

Optional Parameters

Parameter name Value Description
ignore_voter_contact boolean Set to true if the voter wants to ignore this VoterContact entry.

Response

{
  "success": boolean,
  "status": string,
  "ignore_voter_contact" boolean, 
  "email_address_text": string, 
}

Response Status Codes

Code Description
VALID_VOTER_DEVICE_ID_MISSING A valid voter_device_id parameter was not included. Cannot proceed.
VOTER_NOT_FOUND_FROM_VOTER_DEVICE_ID No voter could be found from the voter_device_id

Try It Now: API Variables

Make changes to specific voterContactEmail entries.

Parameter name Value  
voter_device_id:
email_address_text:
ignore_voter_contact: True
False

(opens in new window)