< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/campaignSupporterSave (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
campaignx_we_vote_id string The we_vote_id for the campaign.
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.
supporter_name string The title of the campaign.
supporter_name_changed boolean Are we trying to change the campaign's title?
supporter_endorsement string The title of the campaign.
supporter_endorsement_changed boolean Are we trying to change the campaign's title?
visible_to_public string The title of the campaign.
visible_to_public_changed boolean Are we trying to change the campaign's title?

Response

{
  "status": string,
  "success": boolean,
  "campaignx_we_vote_id": string,
  "date_last_changed": string,
  "date_supported": string,
  "organization_we_vote_id": string,
  "supporter_endorsement": string,
  "supporter_name": string,
  "visible_to_public": boolean,
  "voter_we_vote_id": 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

Parameter name Value  
voter_device_id:
campaignx_we_vote_id:
voter_we_vote_id:
organization_we_vote_id:
supporter_name:
supporter_name_changed: True
False
supporter_endorsement:
supporter_endorsement_changed: True
False
visible_to_public:
visible_to_public_changed: True
False

(opens in new window)