> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mention-me.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> An introduction to our Consumer API

We recommend most brands integrate their app using our Entry Point API which provides links to web views. This enables you to get started quickly, and to rely on the Mention Me platform to provide a rich content editing and branding experience.

In some cases, brands would prefer an "assemble yourself" model, and want to fully customise the experience. The Consumer API provides you the functionality to do this.

<Note>
  Using the Consumer API is significantly more complex than using our Javascript tags or our [EntryPoint API](/api-reference/entry-point-api/overview) and will take more development time to complete.

  If you wish to do this, please contact our [support team](https://help.mention-me.com/hc/en-gb/requests/new) so we can best support you.
</Note>

You can find further documentation about the API endpoints in our [API reference](/api-reference/entry-point-api/overview).

## Share links

When you enrol a referrer via the Consumer API, the response includes a `shareLinks` array containing pre-built share links for each sharing channel (WhatsApp, Facebook, X, SMS, link copy, and others configured for your offer).

Each share link object includes:

| Field                   | Description                                                                          |
| ----------------------- | ------------------------------------------------------------------------------------ |
| `type`                  | The sharing channel (e.g. "whatsapp", "facebook", "link")                            |
| `protocol`              | The URL protocol for the share, if applicable                                        |
| `url`                   | The referral URL to include in the share                                             |
| `defaultShareMessage`   | The pre-rendered share message text for this channel                                 |
| `exampleImplementation` | A ready-to-use share URL you can open directly, or adapt to suit your implementation |

### Dynamic content in share messages

The `defaultShareMessage` field returns fully rendered text with all dynamic content placeholders resolved. Any placeholders configured in your offer's share copy - such as the referrer's first name or custom share fields - are automatically populated with real values.

For example, if your WhatsApp share copy is configured as:

```
Hi, it's {{referrer-firstname}}! I recently used [Brand] and was given an offer...
```

The API returns:

```
Hi, it's Henrietta! I recently used [Brand] and was given an offer...
```

You do not need to perform any placeholder rendering on your side. The message is ready to use as-is.

To configure the share copy and available placeholders for each channel, see [Share messages](/knowledge/referral/design/share-messages).

<CardGroup cols={1}>
  <Card title="Order tracking" icon="truck" href="/api-reference/consumer-api/order-tracking">
    Learn how to pass order data to Mention Me for referral tracking.
  </Card>
</CardGroup>