Share Links for Advocate
Each participant in your referral program has unique share links that they can send to family and friends as an easy way to make referrals. These links will direct the referred person to the landing page you have configured for your referral program, where the Universal Tracking Tag will create an attribution event between the customer advocate and the person they referred.
If you're building a custom Advocate participant experience, then you'll need to include the customer advocate's share link object to dynamically populate their share links.
Before building a custom Advocate experience... Connect with your implementation team to make sure a custom experience is a good fit. We recommend that most clients use the Advocate widget editor to create program widgets. If your organization is unable to do so, e.g., because of a strict Content Security Policy (CSP), then you can create a custom experience instead, using our API or GraphQL to pull in data.
Retrieve the share link object
You can retrieve the share link object you need via REST API, GraphQL, or within your impact.com Advocate program.
Use one of the following REST API calls to retrieve share links.
Use the query user.shareLinks.
In the left navigation menu, select
Engage → Participants.Search for a participant and select their name to open their participant profile.
Select the Codes and links tab.
Find the share link for your program below the Sharelinks heading.
Select the down arrow to the left of the share link, then select See More Sharelinks. This will open the share link object view.
Select the share link object for the engagement medium your widget is using.
Reference
Share links are specific to an engagement medium and a share medium. The engagement medium is the method you use to show a participant's share information to them, e.g., a pop-up widget. The share medium is the method the participant used to distribute their share link to others, e.g, via WhatsApp.
Share mediums
FACEBOOKFBMESSENGERTWITTER(X)EMAILDIRECTLINKEDINSMSWHATSAPPLINEMESSENGERPINTERESTUNKNOWN
Engagement mediums
POPUP
Displayed to participants as a pop-up modal that renders on top of other elements on a page.
EMBED
Displayed to participants in-line as part of your page.
HOSTED
Displayed to participants in a microsite.
cleanShareLink
A share link available on the participant's profile in your Advocate program.
UNKNOWN
A set of share links retrieved for a participant via the user details report.
EMAIL
Displayed to participants in program notification emails.
MOBILE
Displayed to participants via the mobile SDKs.
Share link object example
Last updated