friendInvitationByWeVoteIdSend
< back to index
HTTP request
GET https://api.wevoteusa.org/apis/v1/friendInvitationByWeVoteIdSend (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 |
| other_voter_we_vote_id |
string |
The voter to send the friend invitation to. |
Optional Parameters
| Parameter name |
Value |
Description |
| invitation_message |
string |
An optional message to send. |
Response
{
"status": string,
"success": boolean,
"description_of_send_status": 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
Invite a friend to be your friend from a 'suggested friends' list.