HTTP request
GET https://api.wevoteusa.org/apis/v1/organizationFollow (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 |
organization_id | integer | Internal database unique identifier for organization |
organization_we_vote_id | string | The unique identifier for this organization across all networks (either organization_id OR organization_we_vote_id required -- not both.) NOTE: In the future we might support other identifiers used in the industry. |
organization_twitter_handle | string | The unique identifier for this organization across all networks (either organization_we_vote_id OR organization_twitter_handle required -- not all.) NOTE: In the future we might support other identifiers used in the industry. |
api_key | string (from post, cookie, or get (in that order)) | The unique key provided to any organization using the WeVoteServer APIs |
organization_follow_based_on_issue | boolean | This value holds information for the web-app about how to retrieve voterguides after this api call, False by default |
Response
{ "status": string, "success": boolean, "voter_device_id": string (88 characters long), "organization_id": integer, "organization_we_vote_id": string, "organization_twitter_handle": string, "organization_follow_based_on_issue": boolean, "organization_we_vote_id_that_is_following": string, }
Response Status Codes
Code | Description |
VALID_VOTER_DEVICE_ID_MISSING | A valid voter_device_id parameter was not included. Cannot proceed. |
VALID_VOTER_ID_MISSING | A valid voter_id was not found from voter_device_id. Cannot proceed. |
VALID_ORGANIZATION_ID_MISSING | A valid organization_id was not found. Cannot proceed. |
ORGANIZATION_NOT_FOUND_ON_CREATE FOLLOWING | An organization with that organization_id was not found. Cannot proceed. |
FOLLOWING | Successfully following this organization |
Try It Now: API Variables
Call this to save that the voter is following this organization.