# 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](https://integrations.impact.com/impact-brand/docs/install-the-utt) 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. {% hint style="info" %} **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](https://help.impact.com/en/support/solutions/articles/155000000314-customize-program-widgets) 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. {% endhint %} ## 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. * [REST API](https://integrations.impact.com/impact-brand/?isFramePreview=true#home) * [GraphQL](https://integrations.impact.com/impact-brand/?isFramePreview=true#menu1) * [impact.com](https://integrations.impact.com/impact-brand/?isFramePreview=true#menu2) {% tabs %} {% tab title="Rest API" %} Use one of the following REST API calls to retrieve share links. * [Lookup a user](https://integrations.impact.com/impact-brand/reference/opengetuser) * [Lookup a user's Share URLs](https://integrations.impact.com/impact-brand/reference/getshareurls) * [Lookup a user's Share URLs (Open Endpoint)](https://integrations.impact.com/impact-brand/reference/opengetshareurls) {% endtab %} {% tab title="GraphQL" %} Use the [query](https://integrations.impact.com/impact-brand/docs/graphql-reference) `user.shareLinks`. {% endtab %} {% tab title="impact.com" %} 1. In the left navigation menu, select ![](https://res.cloudinary.com/product-enablement/image/upload/v1768905009/Accessibility%20Icons/engage-v2.svg) **Engage → Participants**. 2. Search for a participant and select their **name** to open their participant profile. 3. Select the **Codes and links** tab. 4. Find the share link for your program below the *Sharelinks* heading. 5. Select the down arrow to the left of the share link, then select **See More Sharelinks**. This will open the share link object view. 6. Select the share link object for the engagement medium your widget is using. {% endtab %} {% endtabs %} ## 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 * `FACEBOOK` * `FBMESSENGER` * `TWITTER` (X) * `EMAIL` * `DIRECT` * `LINKEDIN` * `SMS` * `WHATSAPP` * `LINEMESSENGER` * `PINTEREST` * `UNKNOWN` ### Engagement mediums | Engagement Medium | Description | | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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](https://help.impact.com/en/support/solutions/articles/155000000878-microsites-overview). | | `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](https://help.impact.com/en/support/solutions/articles/155000000320-advocate-program-reports-explained). | | `EMAIL` | Displayed to participants in [program notification emails](https://help.impact.com/en/support/solutions/articles/155000000315-customize-advocate-program-emails). | | `MOBILE` | Displayed to participants via the [mobile SDKs](https://integrations.impact.com/impact-brand/docs/saasquatch-mobile-overview-1). | ### Share link object example {% tabs %} {% tab title="JSON" %} ```javascript { "POPUP": { "FACEBOOK": "https://ssqt.co/m93Jla9", "TWITTER": "https://ssqt.co/mM3Jla9", "EMAIL": "https://ssqt.co/mo3Jla9", "DIRECT": "https://ssqt.co/m53Jla9", "LINKEDIN": "https://ssqt.co/m73Jla9", "SMS": "https://ssqt.co/ma3Jla9", "FBMESSENGER": "https://ssqt.co/mh3Jla9", "WHATSAPP": "https://ssqt.co/mF3Jla9", "LINEMESSENGER": "https://ssqt.co/mD3Jla9", "PINTEREST": "https://ssqt.co/Rz3Jla9", "UNKNOWN": "https://ssqt.co/mB3Jla9" }, "EMBED": { "FACEBOOK": "https://ssqt.co/mw3Jla9", "TWITTER": "https://ssqt.co/mc3Jla9", "EMAIL": "https://ssqt.co/mJ3Jla9", "DIRECT": "https://ssqt.co/mQ3Jla9", "LINKEDIN": "https://ssqt.co/mH3Jla9", "SMS": "https://ssqt.co/m23Jla9", "FBMESSENGER": "https://ssqt.co/mg3Jla9", "WHATSAPP": "https://ssqt.co/mZ3Jla9", "LINEMESSENGER": "https://ssqt.co/mx3Jla9", "PINTEREST": "https://ssqt.co/mf3Jla9", "UNKNOWN": "https://ssqt.co/mX3Jla9" }, "HOSTED": { "FACEBOOK": "https://ssqt.co/mu3Jla9", "TWITTER": "https://ssqt.co/mS3Jla9", "EMAIL": "https://ssqt.co/ml3Jla9", "DIRECT": "https://ssqt.co/mt3Jla9", "LINKEDIN": "https://ssqt.co/mY3Jla9", "SMS": "https://ssqt.co/mq3Jla9", "FBMESSENGER": "https://ssqt.co/mK3Jla9", "WHATSAPP": "https://ssqt.co/mr3Jla9", "LINEMESSENGER": "https://ssqt.co/mW3Jla9", "PINTEREST": "https://ssqt.co/Rm3Jla9", "UNKNOWN": "https://ssqt.co/mA3Jla9" }, "cleanShareLink": "https://ssqt.co/mz3Jla9", "UNKNOWN":{ "FACEBOOK": "https://ssqt.co/mm3Jla9", "TWITTER": "https://ssqt.co/mR3Jla9", "EMAIL": "https://ssqt.co/mL3Jla9", "DIRECT": "https://ssqt.co/mv3Jla9", "LINKEDIN": "https://ssqt.co/m63Jla9", "SMS": "https://ssqt.co/mk3Jla9", "FBMESSENGER": "https://ssqt.co/m03Jla9", "WHATSAPP": "https://ssqt.co/mI3Jla9", "LINEMESSENGER": "https://ssqt.co/m83Jla9", "PINTEREST": "https://ssqt.co/mp3Jla9", "UNKNOWN": "https://ssqt.co/mz3Jla9" }, "EMAIL": { "FACEBOOK": "https://ssqt.co/mT3Jla9", "TWITTER": "https://ssqt.co/mG3Jla9", "EMAIL": "https://ssqt.co/mb3Jla9", "DIRECT": "https://ssqt.co/mP3Jla9", "LINKEDIN": "https://ssqt.co/m13Jla9", "SMS": "https://ssqt.co/mO3Jla9", "FBMESSENGER": "https://ssqt.co/m43Jla9", "WHATSAPP": "https://ssqt.co/mi3Jla9", "LINEMESSENGER": "https://ssqt.co/my3Jla9", "PINTEREST": "https://ssqt.co/RL3Jla9", "UNKNOWN": "https://ssqt.co/mV3Jla9" }, "MOBILE": { "FACEBOOK": "https://ssqt.co/mn3Jla9", "TWITTER": "https://ssqt.co/mC3Jla9", "EMAIL": "https://ssqt.co/mE3Jla9", "DIRECT": "https://ssqt.co/me3Jla9", "LINKEDIN": "https://ssqt.co/m33Jla9", "SMS": "https://ssqt.co/mN3Jla9", "FBMESSENGER": "https://ssqt.co/mU3Jla9", "WHATSAPP": "https://ssqt.co/ms3Jla9", "LINEMESSENGER": "https://ssqt.co/md3Jla9", "PINTEREST": "https://ssqt.co/RR3Jla9", "UNKNOWN": "https://ssqt.co/mj3Jla9" } } ``` {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://integrations.impact.com/integration-guides/for-brands/advocate/share-links-for-advocate.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.