< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterSignOut (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
sign_out_all_devices boolean This is 'False' by default. If set to 'True', sign out all other devices signed into this account by deleting all voter_device_id's linked to this voter account.

Response

{
  "status": string,
  "success": boolean,
  "voter_device_id": string (88 characters long),
}

Response Status Codes

Code Description
DELETE_VOTER_DEVICE_LINK_SUCCESSFUL The voter device link was successfully removed.
DELETE_ALL_VOTER_DEVICE_LINKS_SUCCESSFUL All voter device links for this voter were successfully removed.
DELETE_VOTER_DEVICE_LINK-MISSING_VARIABLES voter_id could not be found from the voter_device_id passed in.
DELETE_ALL_VOTER_DEVICE_LINKS-MISSING_VARIABLES voter_id could not be found from the voter_device_id passed in.
VALID_VOTER_DEVICE_ID_MISSING Cannot proceed. A valid voter_device_id parameter was not included.

Try It Now: API Variables

Sign out from this account. (Delete this voter_device_id from the database.)

Parameter name Value  
voter_device_id:
sign_out_all_devices: True
False

(opens in new window)