< back to index

HTTP request

POST https://api.wevoteusa.org/apis/v1/voterReviewedApp (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.
app_review_state string The new state of the app review stored in voter_voter, one of {"POSITIVE", "NEGATIVE", "NONE"}
app_review_version string The version of the app being reviewed... something like "2.7.4"
app_review_platform string The platform of the app being reviewed, one of {"iOS", "Android"}
app_review_body_negative_bypass string Only when a Negative review is bypassed, this is the message body that is sent to Zendesk. This is not saved in the database.
app_review_email string When a Negative review is bypassed and this email is supplied, use it for a "from" for the email to Zendesk that creates a ticket. If no email is provided, the voter does not want a reply from WeVote, and we supply donotreply@wevote.us as a "from". This is not saved in the database.

Response

[{
  "success": string,
  "status": string,
  "we_vote_id": string,
  "app_review_state": string,
  "app_review_date": string,
  "app_review_version": string,
  "app_review_platform": string,
  "email_api_status_code": string,
  "app_review_email": string,
  "first_name": string,
  "last_name": string,
}]

Try It Now: API Variables

This API is called from Cordova apps when they are prompted to review the app.

For negative reviews where the voter chooses to supply an email and which are screened out by the "Enjoying WeVote?" screening question (appRatePromptTitle), we send that email on to Zendesk which creates a ticket and generates an automatic email reply to the voter. If the voter does not supply an email, we use "donotreply@wevote.us" as the return address so the voter doesn't receive an email, and in that case we put the "we_vote_id" in the ticket body which will allow us to to filter out repetitive complainers and spammers).

For the (hopefully) positive reviews that fall through to the App Store/Play Store process, we won't know if they loved us or hated us, but we log the date of their review so we don't ask them for reviews too often, and display a thank you modal (if the platform allows for that).

In either case we update the voter's record (voter_voter) with the four fields: app_review_state, app_review_version, app_review_platform, & app_review_date.

This will allow us to build automation in the future, so that could start asking for reviews again after a certain number of months, or after a major UI change.

Parameter name Value  
voter_device_id:
app_review_state:
app_review_version:
app_review_platform:
app_review_body_negative_bypass:
app_review_email:

(opens in new window)