< back to index
HTTP request
GET https://api.wevoteusa.org/apis/v1/challengeInviteeSave (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 |
| challenge_we_vote_id |
string |
The we_vote_id for the challenge. |
| voter_we_vote_id |
string |
The voter_we_vote_id for the supporter. |
Optional Parameters
| Parameter name |
Value |
Description |
| organization_we_vote_id |
string |
The organization_we_vote_id for the supporter. |
| invitee_name |
string |
The title of the challenge. |
| invitee_name_changed |
boolean |
Are we trying to change the challenge's title? |
| supporter_endorsement |
string |
The title of the challenge. |
| supporter_endorsement_changed |
boolean |
Are we trying to change the challenge's title? |
| visible_to_public |
string |
The title of the challenge. |
| visible_to_public_changed |
boolean |
Are we trying to change the challenge's title? |
Response
{
"challenge_we_vote_id": string,
"challenge_joined": boolean,
"date_invite_sent": string,
"date_invite_viewed": string,
"date_challenge_joined": string,
"invitee_id": string,
"invitee_name": string,
"invitee_url_code": string,
"inviter_name": string,
"inviter_voter_we_vote_id": string,
"invite_sent": boolean,
"invite_text_from_inviter": string,
"invite_viewed": boolean,
"invite_viewed_count": number,
"next_invitee_url_code": string,
"status": string,
"success": boolean,
"we_vote_hosted_profile_image_url_medium": string,
"we_vote_hosted_profile_image_url_tiny": 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