Help Center

| Submit or View Help Requests | Developer Docs |
| |

Message Links Explained

Message links allow your 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

Adjust message link content
  1. In the left navigation menu, select Program Rules.

  2. Under Section 2, select Customize on the Social messaging card.

  3. If you're using a hosted OpenGraph source, then update the title, description, and image that will be displayed to end users.

  4. In the Share Body text box, adjust the placeholder content for each message link. At minimum, we recommend replacing the content between the pipe characters [|]. To include customized content in the message link, you can use the variables:

    • {shareLink}

    • {referralCode}

    • {companyName}

  5. Save your changes.

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

Add message links to program touchpoints

The content editor allows you to add message links into your program widget and transactional emails 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.

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.

Note

The accountId and userId values must be dynamically populated from your program data. Connect with your development team if you need help with pulling in the data.

Parameter

Example

Description

tenant_alias

test_bpinhag9gag

Your program’s tenant alias. In the left navigation bar, select ellipsis-v-solid.svg [Settings]. Then, under Advocate Settings, select General.

share_medium

WHATSAPP

The medium through which the advocate will share this referral.

Supported values

  • EMAIL

  • FACEBOOK

  • FBMESSENGER

  • LINEMESSENGER

  • LINKEDIN

  • PINTEREST

  • SMS

  • TWITTER

  • WHATSAPP

engagement_medium

EMBED

The medium from which the advocate will engage with the referral program (e.g.,  embedded widget).

Supported values

  • EMAIL

  • EMBED

  • MOBILE

  • POPUP

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

Override the landing page of the program to redirect the resulting share link to a different URL.

Only different paths on your program's landing page URL are supported. For security reasons, the redirection can’t be to a different domain.

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 our demo program, klip-referral-program. This link would be provided in an email, for the participant to share though a mobile link.

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

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.