# Message Links Explained

<a href="https://pxa.impact.com/student/activity/2359755?sid=0c0e3e5c-54c9-4435-9bee-ebcdccb7f292&#x26;sid_i=0?utm_source=app.impact.com&#x26;utm_medium=owned-platform&#x26;utm_content=&#x26;utm_campaign=help-center" class="button primary">Take the PXA course</a>

Message links allow your customer advocates to share pre-formatted messages to various social media platforms. Each message contains your pre-written copy and can include your advocate’s unique share link. Message links can be included in:

* Program widgets
* Transactional emails
* Your app or website, as an embedded link or button
* External email campaigns

<details>

<summary>Adjust message link content</summary>

1. In the left navigation menu, select ![](/files/CDnwOBeIdds9r3Z6zTnO) **\[Engage] → Program Rules**.
2. On the *Program Rules* screen, select the **Sharing** tab.
3. If you're using a *hosted* Open Graph source, then update the **title**, **description**, and **image** that will be displayed to end users.
4. In the *Additional share mediums* section, select all the relevant share mediums you'd like to set a message for and input the message in the *Share Body* section.

   <div data-with-frame="true"><figure><img src="/files/uF0iZaZFrgBryuVR0p3Z" alt=""><figcaption></figcaption></figure></div>
5. Select **Save Share Messaging** to save your content.

Your message links can now be included in your referral program's widget and transactional emails, or embedded elsewhere on your website, app, or email campaigns.

</details>

<details>

<summary>Add message links to program touchpoints</summary>

The content editor allows you to add message links to your [program widget](/brand/readme/advocate-program/manage-advocate-participant-experiences/widget-experiences/customize-program-widgets.md) and [transactional emails](/brand/readme/advocate-program/manage-advocate-participant-experiences/email-experiences/create-and-customize-advocate-program-emails.md) with minimal additional setup—only your program ID is required. To insert message links elsewhere, you can embed a link that follows the format below.

```programlisting
https://app.referralsaasquatch.com/a/ 
{tenant_alias}/message/redirect/{share_medium}
?engagementMedium={engagement_medium}&accountId= 
{accountId}&userId={userId}&programId=
{program_ID}&rsLandingPage= {rsLandingPage}
```

Information contained in the curly brackets **{ }** should be replaced with one of the supported parameter values.

{% hint style="info" %}
**Note:** The `accountId` and `userId` values must be dynamically populated from your program data. Connect with your development team if you need help pulling in the data.
{% endhint %}

| Parameter                  | Example                              | Description                                                                                                                                                                                                                                                                                                                                                                  |
| -------------------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tenant_alias`             | `test_bpinhag9gag`                   | <p>Your program’s tenant alias. To find your tenant alias:</p><p>1. From the top navigation bar, select <img src="/files/2qeX6EqajzdOPiwzfeV5" alt=""> <strong>\[User profile] → Settings</strong>.</p><p>2. On the left, under <em>Advocate Settings</em>, select <strong>General</strong>.</p>                                                                             |
| `share_medium`             | `WHATSAPP`                           | <p>The medium through which the advocate will share this referral.</p><p>Supported values:</p><p>• <code>EMAIL</code></p><p>• <code>FACEBOOK</code></p><p>• <code>FBMESSENGER</code></p><p>• <code>LINEMESSENGER</code></p><p>• <code>LINKEDIN</code></p><p>• <code>PINTEREST</code></p><p>• <code>SMS</code></p><p>• <code>TWITTER</code></p><p>• <code>WHATSAPP</code></p> |
| `engagement_medium`        | `EMBED`                              | <p>The medium from which the advocate will engage with the referral program (e.g., embedded widget).</p><p>Supported values:</p><p>• <code>EMAIL</code></p><p>• <code>EMBED</code></p><p>• <code>MOBILE</code></p><p>• <code>POPUP</code></p>                                                                                                                                |
| `accountId`                | \[Hashed ID based on email address]  | The account ID for whom this message link is being built. For most participants, the user ID and account ID fields have the same value.                                                                                                                                                                                                                                      |
| `userId`                   | \[Hashed ID based on email address]  | The user ID for whom this message link is being built. For most participants, the user ID and account ID fields have the same value.                                                                                                                                                                                                                                         |
| `programId`                | `21789`                              | Your program ID. It can be found on the **Program Rules** page below the program name.                                                                                                                                                                                                                                                                                       |
| `rsLandingPage` (Optional) | `https://example.com/driver-program` | <p>Override the landing page of the program to redirect the resulting share link to a different URL.</p><p>Only different paths on your program's landing page URL are supported. For security reasons, the redirection can’t be to a different domain.</p>                                                                                                                  |

{% hint style="info" %}
**Example:** Using the above format, the following is an example of what the message link URL would look like for a participant with the user ID and account ID `messageLink` in the impact.com demo program, `klip-referral-program`. This link would be provided in an email, for the participant to share through a mobile link.

```programlisting
https://app.referralsaasquatch.com/a/test_aut32av0b11uc
/message/redirect/EMAIL?engagementMedium=
MOBILE&accountId=messageLink&userId=
messageLink&programId=klip-referral-program
```

{% endhint %}

</details>


---

# 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://help.impact.com/brand/readme/advocate-program/manage-advocate-participant-experiences/message-links-explained.md?ask=<question>
```

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.