< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/friendInvitationInformation (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
invitation_secret_key string We pass in the secret key as an identifier.

Response

{
  "status": string,
  "success": boolean,
  "voter_device_id": string (88 characters long),
  "friend_first_name": string,
  "friend_last_name": string,
  "friend_image_url_https_tiny": string,
  "friend_issue_we_vote_id_list": list,
  "friend_we_vote_id": string,
  "friend_organization_we_vote_id": string,
  "invitation_found": boolean,
  "invitation_message": string,
  "invitation_secret_key": string,
}

Response Status Codes

Code Description
VALID_VOTER_DEVICE_ID_MISSING Cannot proceed. A valid voter_device_id parameter was not included.
MISSING_VOTER_ID_OR_ADDRESS_TYPE Cannot proceed. Missing variables voter_id or address_type while trying to save.

Try It Now: API Variables

Accept an invitation to be someone's friend based on a secret key.

Parameter name Value  
voter_device_id:
invitation_secret_key:

(opens in new window)