< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/sharedItemSave (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
destination_full_url	string	The full URL with the final destination.
other_voter_email_address_text	string	The email address of the person you are sharing with. Required if is_remind_contact_share.
shared_by_voter_we_vote_id	string	The voter_we_vote_id of the person who is sharing.

Optional Parameters

Parameter name	Value	Description
ballot_item_we_vote_id	string	The we_vote_id for the ballot item being shared.
google_civic_election_id	integer	The unique identifier for a particular election.
is_ballot_share	boolean	The kind of destination shared: Ballot page
is_candidate_share	boolean	The kind of destination shared: Candidate page
is_measure_share	boolean	The kind of destination shared: Measure page
is_office_share	boolean	The kind of destination shared: Office page
is_organization_share	boolean	The kind of destination shared: Voter Guide page
is_ready_share	boolean	The kind of destination shared: Ready page
is_remind_contact_share	boolean	Send remind a contact to vote email
organization_we_vote_id	string	The organization the voter wants to share.
other_voter_email_address_text	string	The text of the email address of the friend the current voter is sharing with.
other_voter_display_name	string	The full display name of the friend the current voter is sharing with.
other_voter_first_name	string	The first name (given name) of the friend the current voter is sharing with.
other_voter_last_name	string	The last name (family name) of the friend the current voter is sharing with.
other_voter_we_vote_id	string	The voter_we_vote_id of the friend the current voter is sharing with (if we have it).
shared_message	string	The message to send to the friend the current voter is sharing with.

Response

{
  "status": string,
  "success": boolean,
  "candidate_we_vote_id": string,
  "date_first_shared": datetime,
  "destination_full_url": string,
  "google_civic_election_id": integer,
  "is_ballot_share": boolean,
  "is_candidate_share": boolean,
  "is_measure_share": boolean,
  "is_office_share": boolean,
  "is_organization_share": boolean,
  "is_ready_share": boolean,
  "is_remind_contact_share": boolean,
  "measure_we_vote_id": string,
  "office_we_vote_id": string,
  "other_voter_display_name": string,
  "other_voter_email_address_text": string,
  "other_voter_first_name": string,
  "other_voter_last_name": string,
  "other_voter_we_vote_id": string,
  "shared_by_display_name": string,
  "shared_by_first_name": string,
  "shared_by_last_name": string,
  "shared_by_email_address_text": string,
  "shared_by_organization_type": string,
  "shared_by_organization_we_vote_id": string,
  "shared_by_voter_we_vote_id": string,
  "shared_by_we_vote_hosted_profile_image_url_large": string,
  "shared_by_we_vote_hosted_profile_image_url_medium": string,
  "shared_by_we_vote_hosted_profile_image_url_tiny": string,
  "shared_item_code_no_opinions": string,
  "shared_item_code_all_opinions": string,
  "site_owner_organization_we_vote_id": string,
  "url_with_shared_item_code_no_opinions": string,
  "url_with_shared_item_code_all_opinions": 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:
destination_full_url:
other_voter_email_address_text:
shared_by_voter_we_vote_id:
ballot_item_we_vote_id:
google_civic_election_id:
is_ballot_share:	True False
is_candidate_share:	True False
is_measure_share:	True False
is_office_share:	True False
is_organization_share:	True False
is_ready_share:	True False
is_remind_contact_share:	True False
organization_we_vote_id:
other_voter_email_address_text:
other_voter_display_name:
other_voter_first_name:
other_voter_last_name:
other_voter_we_vote_id:
shared_message:

(opens in new window)