< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/friendInviteResponse (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
kind_of_invite_response string Default is ACCEPT_INVITATION. Other options include DELETE_INVITATION_EMAIL_SENT_BY_ME, DELETE_INVITATION_VOTER_SENT_BY_ME, IGNORE_INVITATION, UNFRIEND_CURRENT_FRIEND.
voter_we_vote_id string The unique identifier for the voter who sent the invitation.
recipient_voter_email string The email address the invitation was sent to (when a recipient we_vote_id could not be found.

Response

{
  "status": string,
  "success": boolean,
  "voter_we_vote_id": string,
  "kind_of_invite_response": string, 
  "friend_voter": dict
   {
     "voter_we_vote_id": string,
     "voter_display_name": string,
     "voter_photo_url": string,
     "voter_twitter_handle": string,
     "voter_twitter_description": string,
     "voter_twitter_followers_count": number,
     "voter_state_code": string,
   },
}

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. A valid voter_id was not found.

Try It Now: API Variables

Respond to friend request.

Parameter name Value  
voter_device_id:
kind_of_invite_response:
voter_we_vote_id:
recipient_voter_email:

(opens in new window)