voterNotificationSettingsUpdate
< back to index
HTTP request
GET https://api.wevoteusa.org/apis/v1/voterNotificationSettingsUpdate (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 |
Optional Parameters
| Parameter name |
Value |
Description |
| email_subscription_secret_key |
string |
A long string which tells us which email we want the notification options updated for. |
| interface_status_flags |
integer |
An integer whose bits represent several flags for the user, such as the |
| flag_integer_to_set |
integer |
Sets the corresponding bit represented by this integer's bit, in interface_status_flags bit |
| flag_integer_to_unset |
integer |
Unsets the corresponding bit represented by this integer's bit, in interface_status_flags bit |
| notification_settings_flags |
integer |
An integer whose bits represent several flags for the user, such as the |
| notification_flag_integer_to_set |
integer |
Sets the corresponding bit represented by this integer's bit, in notification_settings_flags bit |
| notification_flag_integer_to_unset |
integer |
Unsets the corresponding bit represented by this integer's bit, in notification_settings_flags bit |
Response
{
"status": string (description of what happened),
"success": boolean (True as long as no db errors),
"voter_found": boolean (True if voter found from secret key),
"voter_updated": boolean (True if save executed successfully),
"email_subscription_secret_key": string (88 characters long),
"sms_subscription_secret_key": string (88 characters long),
"interface_status_flags": integer,
"flag_integer_to_set": integer,
"flag_integer_to_unset": integer,
"notification_settings_flags": integer,
"notification_flag_integer_to_set": integer,
"notification_flag_integer_to_unset": integer,
}
Response Status Codes
| Code |
Description |
| UPDATED_VOTER |
Successfully saved |
Try It Now: API Variables
Update profile-related information for a voter based on secret key. If the string 'False' is passed (or the boolean value), do not update the field.