# Public Methods

The **ReferralHero Flutter SDK** provides a simple and efficient way to integrate referral and contest functionality into your Flutter application. The SDK offers a set of public methods to access data, execute various tasks, and interact with the ReferralHero API.

The main class for interaction is `ReferralHeroFlutter`. This class is designed as a singleton, ensuring that the SDK is ready to use throughout the application lifecycle. It is recommended to initialize the SDK on the very first screen of your app.

## 1. Add a Subscriber

This method is most commonly used to add an organic subscriber or create a referral (if identified) after a user successfully signs up or logs in to your app.

When using this method please take note of your Campaign Goal as our tracking logic will depend on if you are tracking a single or multi-step conversion event.

{% hint style="info" %}
**GOAL: One Conversion Event**\
If you have your Campaign Goal set up to track one conversion event, the following tracking logic will take place:

* If a referral, a referral will be automatically created and set to Confirmed in the correct campaign.
* If not a referral, an organic subscriber will be created in the campaign UUID specified.
* If the subscriber exists in our database, the subscriber will be 'identified'. Data is not overwritten. Additional data will be created.
  {% endhint %}

{% hint style="info" %}
**GOAL: Two or Three Conversion Events**\
If you have your Campaign Goal set up to track two or three conversion events, the following tracking logic will take place:

* If a referral, a referral will be created and set to Pending in the correct campaign.
* If not a referral, an organic subscriber will be created in the campaign UUID specified.
* If the subscriber exists in our database, the subscriber will be 'identified'. Data is not overwritten.
  {% endhint %}

To add a subscriber (for example, post a successful signup or login) call the function and send the params information such as email address and name. The minimum values you should send for the endpoint to work are the following:

```dart
final subscriber = { 
    "email": "johnDoe123@gmail.com", 
    "domain": "https://a.domain.co/", 
}
```

**To identify and create a referral**, you must also send either the setReferrer OR the required mobile params so that our matching algorithm can automatically identify a referral.

```dart
"os_type": "Android",
"device": "Android",
"ip_address": "123.156.219.010",
"screen_size": "432.0 x 960.0",
```

{% hint style="warning" %}
NOTE:\
The mobile parameters must be sent in the correct format for our system to automatically identify and create a referral. See the Getting Started section [here](https://support.referralhero.com/integrate/mobile-sdks/getting-started#tracking-referrals).
{% endhint %}

The accepted Screen Size formats are:

```kotlin
"screen_size":"393*852"
"screen_size":"393 x 852"
"screen_size":"393x852"
"screen_size":"393.0 x 852.0"
// in case you need to hard code values
```

#### Request Body

| Name                                                       | Type    | Description                                                                                             |
| ---------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------- |
| email<mark style="color:red;">\*</mark>                    | String  | The email of the subscriber. Required if email is the unique identifier for the campaign.               |
| name                                                       | String  | The name of the subscriber                                                                              |
| crypto\_wallet\_address<mark style="color:red;">\*</mark>  | String  | The crypto wallet address. Required if it is the unique identifier for the campaign.                    |
| phone\_number<mark style="color:red;">\*</mark>            | String  | The phone number of the subscriber. Required if phone number is the unique identifier for the campaign. |
| extra\_field                                               | String  | The extra field value of the subscriber                                                                 |
| extra\_field\_2                                            | String  | The extra field 2 value of the subscriber                                                               |
| referrer                                                   | String  | The referral code or email of the referrer                                                              |
| lifetime\_spend                                            | Number  | Lifetime spend of the subscriber                                                                        |
| subscribe\_page\_url                                       | String  | Subscribe Page URL of the Subscriber                                                                    |
| landing\_page\_url                                         | String  | Landing Page URL of the Subscriber                                                                      |
| is\_quick\_add\_referral                                   | Boolean | Send **True** only if you want to add the referral as Quick Add Referral otherwise **False**            |
| option\_field\_value                                       | String  | Option field value of the subscriber                                                                    |
| other\_identifier\_value<mark style="color:red;">\*</mark> | String  | The other identifier value (Required if other identifier enabled as unique identifier)                  |
| double\_optin                                              | Boolean | Send **True** if you want to send verification method before adding otherwise **False**                 |
| points                                                     | Integer | Points of the subscriber                                                                                |
| crypto\_wallet\_provider                                   | String  | The crypto wallet provider                                                                              |
| screen\_size                                               | String  | The screen size of device used by subscriber when the referral link was clicked                         |
| ip\_address                                                | String  | The IP address used by subscriber when the referral link was clicked                                    |
| device                                                     | String  | The device used by subscriber when the referral link was clicked                                        |
| os\_type                                                   | String  | The Type of Operating system used by subscriber when the referral link was clicked                      |
| source                                                     | String  | The source of the subscriber.                                                                           |
| domain                                                     | String  | URL used to generate the referral link.                                                                 |
| transaction\_id                                            | String  | The unique ID of the transaction. Useful when tracking purchases.                                       |
| conversion\_category                                       | String  | The type of subscriber. Useful for creating reports or segmenting subscribers.                          |
| conversion\_value                                          | Number  | The monetary conversion value of the subscriber                                                         |
| status                                                     | String  | Use 'custom\_event\_pending' to set the referral status to pending                                      |

{% tabs %}
{% tab title="Example Request" %}

```dart
final subscriber = { 
    "email": "test24@gmail.com", //Required value, capture this from user
    "domain": "https://yourwebsite.com", //Required value, should match the default referral link set within your RH account
    "name": "Test User 24", //Optional but recommended, capture this from user
    "referrer": referrer_input?.text, //Optional value, only necessary if the user will provide the referrer code directly, otherwise the below 4 params are required 
    "ip_address": referralHeroService.deviceInfo.getIpAddress(), //Required value, necessary if you want RH to automatically identify & create a referral without the user providing the setReferrer params
    "os_type": referralHeroService.deviceInfo.getOperatingSystem(), //Required value, necessary if you want RH to automatically identify & create a referral without the user providing the setReferrer params
    "screen_size": referralHeroService.deviceInfo.getDeviceScreenSize(), //Required value, necessary if you want RH to automatically identify & create a referral without the user providing the setReferrer params
    "device": referralHeroService.deviceInfo.getDeviceType(),  //Required value, necessary if you want RH to automatically identify & create a referral without the user providing the setReferrer params    
    "status": "custom_event_pending", //Use 'custom_event_pending' to set the referral status to pending
};

await referralHeroService.addSubscriber(subscriber);
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "id": "sub_a1d333c890bf",
        "name": "Test User 10",
        "email": "test15@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "33d278b9",
        "position": 21,
        "referred": false,
        "referred_by": {},
        "people_referred": 0,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1685018452,
        "points": 0,
        "risk_level": 0,
        "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic",
        "source": null,
        "device": null,
        "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=33d278b9",
        "created_at": 1685018451,
        "last_updated_at": 1685018452,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=33d278b9",
        "status": "",
        "response": "subscriber_retrieved"
    },
    "calls_left": null,
    "timestamp": 1692865024
}
```

{% endtab %}
{% endtabs %}

## 2. Add Pending Referral

This method is most commonly used to create a referral entering the 1st step of your multi-step conversion event funnel (i.e. after a referred user successfully signs up for your app). If you want us to automatically add every user to your campaign and determine if the user is a referral or not, use the Add Subscriber method instead. This logic only checks for referrals:

{% hint style="info" %}
**Tracking Logic**

**GOAL: Two or Three Conversion Events**

Your campaign Goal must be set up to track two or three conversion events, and then the following tracking logic will take place:

* If a referral, a referral will be automatically created and set to Pending in the correct campaign.
* If not a referral, no subscriber will be created.&#x20;
  {% endhint %}

#### Request Body

| Name                     | Type   | Description                                                                                                                 |
| ------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| email                    | String | The email of the subscriber. Required if email is the unique identifier for the campaign.                                   |
| phone\_number            | String | The phone number of the subscriber. Required if phone number is the unique identifier for the campaign.                     |
| crypto\_wallet\_address  | String | The crypto wallet address of the subscriber. Required if crypto wallet address is the unique identifier for the campaign.   |
| other\_identifier\_value | String | The other identifier value of the subscriber. Required if other identifier value is the unique identifier for the campaign. |

{% tabs %}
{% tab title="Example Request" %}

```dart
final referralParams = {
  "email": "pending@example.com", //Required value, capture this from user
  "name": "Pending User", //Optional but recommended, capture this from user
  "referrer": "8f01d5db", // Optional value, only necessary if the user will provide the referrer code directly, otherwise the below 4 params are required
  "ip_address": referralHeroService.deviceInfo.getIpAddress(), // Required value, necessary if you want RH to automatically identify & create a referral without the user providing the setReferrer params
  "os_type": referralHeroService.deviceInfo.getOperatingSystem(), // Required value, necessary if you want RH to automatically identify & create a referral without the user providing the setReferrer params
  "screen_size": referralHeroService.deviceInfo.getDeviceScreenSize(), // Required value, necessary if you want RH to automatically identify & create a referral without the user providing the setReferrer params
  "device": referralHeroService.deviceInfo.getDeviceType(),  // Required value, necessary if you want RH to automatically identify & create a referral without the user providing the setReferrer params
};

await referralHeroService.createPendingReferral(referralParams);
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "id": "sub_a1d333c890bf",
        "name": "Test User 10",
        "email": "test15@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "33d278b9",
        "position": 21,
        "referred": false,
        "referred_by": {},
        "people_referred": 0,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1685018452,
        "points": 0,
        "risk_level": 0,
        "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic",
        "source": null,
        "device": null,
        "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=33d278b9",
        "created_at": 1685018451,
        "last_updated_at": 1685018452,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=33d278b9",
        "status": "",
        "response": "subscriber_retrieved"
    },
    "calls_left": null,
    "timestamp": 1692865024
}
```

{% endtab %}
{% endtabs %}

To add a pending referral, simply call ReferralHero's `createPendingReferral` function and send the `referralParams` data.

The minimum values for this endpoint to work:

```dart
final referralParams = {
  "email": signup_email?.text,
  "referrer": "M12345fc2",
};
```

OR:

```dart
final referralParams = {
  "email": signup_email?.text,
  "ip_address": referralHeroService.deviceInfo.getIpAddress(), 
  "os_type": referralHeroService.deviceInfo.getOperatingSystem(),
  "screen_size": referralHeroService.deviceInfo.getDeviceScreenSize(),
  "device": referralHeroService.deviceInfo.getDeviceType(),
};
```

{% hint style="info" %}
NOTE:\
The mobile parameters must be sent in the correct format for our system to automatically identify and create a referral. See the Getting Started section [here](https://support.referralhero.com/integrate/mobile-sdks/getting-started#tracking-referrals).
{% endhint %}

## 3. Track Referral

This method is used for tracking a referral conversion event (i.e. a purchase, but can be any conversion event).&#x20;

{% hint style="info" %}
**Tracking Logic**:

* If a referral and pre-existing in the campaign as Pending

**OR**

* If a referral and setReferrer or mobile params are provided, a referral is automatically created in the correct campaign and

**The Referral Is Set To:**

* Confirmed (if tracking two conversion events)
* Unconfirmed (if tracking three conversion events)
  {% endhint %}

**Note:**

1\. Your campaign must be set up as a custom event or a multi-step event otherwise, an error will return.

2\. If the referral is present in ReferralHero with pending status, a successful response `custom_event_completed` will return.

3\. If the referral unique identifier is not present in the ReferralHero, but the referrer unique identifier is present, a successful response `custom_event_completed` with the data of the new confirmed referral will return.

4\. If a referral exists but the referral status is not pending, the error `custom event is already completed` will return.

5\. If the referral unique identifier is not present in ReferralHero and the referrer is also not provided in the API, the error `referer is invalid or not present` will return.

6\. If the referral status is unconfirmed or confirmed, the error `custom event is already completed` will return.

{% hint style="warning" %}
When tracking referrals on your App you should ALWAYS send the ACTUAL unique identifier (email, phone number, crypto wallet address, or other ID) of the user in referralParams class Object.
{% endhint %}

#### Request Body

| Name                                                      | Type   | Description                                                                                                                 |
| --------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| email<mark style="color:red;">\*</mark>                   | String | The email of the subscriber. Required if email is the unique identifier for the campaign.                                   |
| crypto\_wallet\_address<mark style="color:red;">\*</mark> | String | The crypto wallet address. Required if crypto wallet address is the unique identifier for the campaign.                     |
| phone\_number<mark style="color:red;">\*</mark>           | String | The phone number of the subscriber. Required if phone number is the unique identifier for the campaign.                     |
| other\_identifier\_value                                  | String | <p>The other identifier value. Required if other identifier value is the unique identifier for the campaign.</p><p><br></p> |

Create a **ReferralParams** class object and set the various user details to identify the user matching your back-end system.

{% tabs %}
{% tab title="Example Request" %}

```dart
final referralParams = {
  "email": signup_email?.text, //Required value, capture this from user
  "name": signup_name?.text, //Optional value but recommended, capture this from user
  "referrer": "M12345fc2", //Optional value, only required if the user does not exist in the campaign
  "ip_address": referralHeroService.deviceInfo.getIpAddress(), //Optional value, only required if the user does not exist in the campaign
  "os_type": referralHeroService.deviceInfo.getOperatingSystem(), //Optional value, only required if the user does not exist in the campaign
  "screen_size": referralHeroService.deviceInfo.getDeviceScreenSize(), //Optional value, only required if the user does not exist in the campaign
  "device": referralHeroService.deviceInfo.getDeviceType(),  //Optional value, only required if the user does not exist in the campaign
};

await referralHeroService.trackReferral(referral);
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "id": "sub_f3922a951cc3",
        "name": "Tarun Garg",
        "email": "taru820@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "4553",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "153aaf07",
        "position": 38,
        "referred": true,
        "referred_by": {
            "id": "sub_cd581757b137",
            "name": "Test User 10",
            "email": "test18@gmail.com",
            "code": "c6ff0e6f",
            "people_referred": 0,
            "points": 0
        },
        "people_referred": 0,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1692957804,
        "points": 0,
        "risk_level": 0,
        "host": "http://localhost:4005/",
        "source": null,
        "device": null,
        "referral_link": "http://localhost:4005/?mwr=153aaf07",
        "created_at": 1692957804,
        "last_updated_at": 1692957881,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxx/universal_link?mwr=153aaf07",
        "status": "unconfirmed",
        "response": "custom_event_completed"
    },
    "calls_left": null,
    "timestamp": 1692957881
}
```

{% endtab %}
{% endtabs %}

**If the referral is pre-existing in the campaign**, the minimum value for this endpoint to work:

```dart
final referralParams = {
  "email": signup_email?.text,  
};
```

{% hint style="info" %}
**If the referral is NOT pre-existing in the campaign** (and you want to identify and create a referral), you must send either the setReferrer OR the required mobile parameters in the correct format so that our matching algorithm can automatically identify a referral. See the Getting Started section [here](https://support.referralhero.com/integrate/mobile-sdks/getting-started#tracking-referrals).
{% endhint %}

## 4. Confirm Referral

Use this method when your Campaign Goal is set to track three conversion events and you want to confirm a referral when your third conversion event occurs (complete profile, upgrade to a paid plan, end of the trial, etc).

{% hint style="info" %}
**Tracking Logic**:

* If a referral and pre-existing in the campaign as Unconfirmed

**The Referral Is Set To:**

* Confirmed (if tracking three conversion events)
  {% endhint %}

{% hint style="warning" %}
**Note:** only verified referrals can be confirmed. Trying to confirm a non-verified referral will return a `subscriber_not_found` error.
{% endhint %}

#### Request Body

| Name                     | Type   | Description                                                                                                                 |
| ------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| email                    | String | The email of the subscriber. Required if email is the unique identifier for the campaign.                                   |
| other\_identifier\_value | String | The other identifier value of the subscriber. Required if other identifier value is the unique identifier for the campaign. |
| crypto\_wallet\_address  | String | The crypto wallet address of the subscriber. Required if crypto wallet address is the unique identifier for the campaign.   |
| phone\_number            | String | The phone number of the subscriber. Required if phone number is the unique identifier for the campaign.                     |

{% tabs %}
{% tab title="Example Request" %}

```dart
await referralHeroService.confirmReferral('subscriberId');
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "id": "sub_f3922a951cc3",
        "name": "Tarun Garg",
        "email": "taru820@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "4553",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "153aaf07",
        "position": 38,
        "referred": true,
        "referred_by": {
            "id": "sub_cd581757b137",
            "name": "Test User 10",
            "email": "test18@gmail.com",
            "code": "c6ff0e6f",
            "people_referred": 1,
            "points": 0
        },
        "people_referred": 0,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1692957804,
        "points": 0,
        "risk_level": 0,
        "host": "http://localhost:4005/",
        "source": null,
        "device": null,
        "referral_link": "http://localhost:4005/?mwr=153aaf07",
        "created_at": 1692957804,
        "last_updated_at": 1692959314,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxx/universal_link?mwr=153aaf07",
        "status": "confirmed",
        "response": "subscriber_confirmed"
    },
    "calls_left": null,
    "timestamp": 1692959314
}
```

{% endtab %}
{% endtabs %}

## 5. Organic Track Referral

If you would like to add an organic subscriber or a track referral on the conversion page to your referral campaign, you can use the following method. This method would most commonly be used if the **user has not been previously added to your campaign** and instead directly passes through a post-checkout/subscribe event.

{% hint style="info" %}
**Tracking Logic**:

* If a referral and pre-existing in the campaign as Pending

**OR**

* If a referral and setReferrer or mobile params are provided, a referral is automatically created in the correct campaign and

**The Referral Is Set To:**

* Confirmed (if tracking two conversion events)
* Unconfirmed (if tracking three conversion events)

**OR**

* If not a referral, an organic subscriber is created in the campaign UUID specified.
  {% endhint %}

#### Request Body

| Name                     | Type   | Description                                                                                                                 |
| ------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------- |
| email                    | String | The email of the subscriber. Required if email is the unique identifier for the campaign.                                   |
| phone\_number            | String | The phone number of the subscriber. Required if phone number is the unique identifier for the campaign.                     |
| crypto\_wallet\_address  | String | The crypto wallet address of the subscriber. Required if crypto wallet address is the unique identifier for the campaign.   |
| other\_identifier\_value | String | The other identifier value of the subscriber. Required if other identifier value is the unique identifier for the campaign. |

Create a [ReferralParams ](https://docs.google.com/document/d/1pTU0vB9RKZ5_us-ycdFVJFb4TvYuOKuPRVFjQu8cVv0/edit#heading=h.dlqm64495bqt)class object and set the various user details to identify the user matching your back-end system.

To add an organic referral track, simply call ReferralHero's `referralHeroService.organicTrackReferral()` function and send the ReferralParams information such as email address and name.

{% tabs %}
{% tab title="Example Request" %}

```dart
final referralParams = {
  "email": signup_email?.text,
  "name": signup_name?.text,
};

await referralHeroService.organicTrackReferral(referralParams);
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
  "status": "ok",
  "data": {
    "id": "sub_41adff0cfc8e",
    "name": "Test organic User1",
    "email": "testorganic1@gmail.com",
    "phone_number": "",
    "crypto_wallet_address": "",
    "crypto_wallet_provider": "",
    "extra_field": "",
    "extra_field_2": "",
    "option_field": "",
    "conversion_amount": 0,
    "code": "23e0fb1c",
    "position": 5,
    "referred": true,
    "referred_by": {
      "id": "sub_7b9be1ed8ccb",
      "name": "Test User 10",
      "email": "test15@gmail.com",
      "code": "2c2dbefb",
      "people_referred": 0,
      "points": 0
    },
    "people_referred": 0,
    "promoted": false,
    "promoted_at": null,
    "verified": true,
    "verified_at": 1685020506,
    "points": 0,
    "risk_level": 0,
    "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic",
    "source": null,
    "device": null,
    "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=23e0fb1c",
    "created_at": 1685020506,
    "last_updated_at": 1685020506,
    "os_type": null,
    "screen_size": null,
    "ip_address": null,
    "response": "subscriber_created"
  },
  "calls_left": null,
  "timestamp": 1685020506
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**If the referral is NOT pre-existing in the campaign** (and you want to identify and create a referral), you must send either the setReferrer OR the required mobile parameters in the correct format so that our matching algorithm can automatically identify a referral. See the Getting Started section [here](https://support.referralhero.com/integrate/mobile-sdks/getting-started#tracking-referrals).
{% endhint %}

## 6. Update Subscriber Details

This method is used to update various user-related data like username, address, etc. Request parameters are the same as before in the Add a Subscriber API.

Required body parameters are noted below, otherwise, all other available subscriber attributes can be found above under 'Add a Subscriber'.

#### Request Body

| Name                                                       | Type   | Description                                                                                             |
| ---------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------- |
| email<mark style="color:red;">\*</mark>                    | String | The email of the subscriber. Required if email is the unique identifier for the campaign.               |
| phone\_number<mark style="color:red;">\*</mark>            | String | The phone number of the subscriber. Required if phone number is the unique identifier for the campaign. |
| crypto\_wallet\_address<mark style="color:red;">\*</mark>  | String | The crypto wallet address. Required if it is the unique identifier for the campaign.                    |
| other\_identifier\_value<mark style="color:red;">\*</mark> | String | The other identifier value. Required if other identifier enabled as unique identifier.                  |

{% tabs %}
{% tab title="Example Request" %}

```dart
final updates = {
  "email": "test102@gmail.com",
  "name": "Test name new",
  "os_type": "Ubuntu"
};

await referralHeroService.updateSubscriber('subscriberId', updates);
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "id": "sub_a1d333c890bf",
        "name": "Test User 10",
        "email": "test15@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "33d278b9",
        "position": 21,
        "referred": false,
        "referred_by": {},
        "people_referred": 0,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1685018452,
        "points": 0,
        "risk_level": 0,
        "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic",
        "source": null,
        "device": null,
        "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=33d278b9",
        "created_at": 1685018451,
        "last_updated_at": 1685018452,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxx/universal_link?mwr=33d278b9",
        "status": "",
        "response": "subscriber_retrieved"
    },
    "calls_left": null,
    "timestamp": 1692865024
}
```

{% endtab %}
{% endtabs %}

## 7. Get Subscriber Details

This method is used to get the details of a particular subscriber.

#### Request Parameters

| Name                                             | Type   | Description               |
| ------------------------------------------------ | ------ | ------------------------- |
| subscriber\_id<mark style="color:red;">\*</mark> | String | The ID of the subscriber. |

{% tabs %}
{% tab title="Example Request" %}

```dart
final details = await referralHeroService.getSubscriberDetails('subscriberId');
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "id": "sub_a1d333c890bf",
        "name": "Test User 10",
        "email": "test15@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "33d278b9",
        "position": 21,
        "referred": false,
        "referred_by": {},
        "people_referred": 0,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1685018452,
        "points": 0,
        "risk_level": 0,
        "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic",
        "source": null,
        "device": null,
        "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=33d278b9",
        "created_at": 1685018451,
        "last_updated_at": 1685018452,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxx/universal_link?mwr=33d278b9",
        "status": "",
        "response": "subscriber_retrieved"
    },
    "calls_left": null,
    "timestamp": 1692865024
}
```

{% endtab %}
{% endtabs %}

## 8. Delete Subscriber

This method is used to Delete a Subscriber.

#### Request Parameters

| Name                                             | Type   | Description               |
| ------------------------------------------------ | ------ | ------------------------- |
| subscriber\_id<mark style="color:red;">\*</mark> | String | The ID of the subscriber. |

{% tabs %}
{% tab title="Example Request" %}

```dart
await referralHeroService.deleteSubscriber('subscriberId');
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "id": "sub_a1d333c890bf",
        "name": "Test User 10",
        "email": "test15@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "33d278b9",
        "position": 21,
        "referred": false,
        "referred_by": {},
        "people_referred": 0,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1685018452,
        "points": 0,
        "risk_level": 0,
        "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic",
        "source": null,
        "device": null,
        "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic?mwr=33d278b9",
        "created_at": 1685018451,
        "last_updated_at": 1685018452,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=33d278b9",
        "status": "",
        "response": "subscriber_retrieved"
    },
    "calls_left": null,
    "timestamp": 1692865024
}
```

{% endtab %}
{% endtabs %}

## 9. Capture Share

This method is used with parameters like 'copy', 'sms', 'facebook', 'twitter', etc. to capture a Share Event.

#### Request Body

| Name   | Type               | Description                                    |
| ------ | ------------------ | ---------------------------------------------- |
| social | facebook           | To capture a 'facebook' share event.           |
| social | twitter            | To capture a 'twitter' share event.            |
| social | linkedin           | To capture a 'linkedin' share event.           |
| social | email              | To capture a 'email' share event.              |
| social | telegram           | To capture a 'telegram' share event.           |
| social | sms                | To capture a 'sms' share event.                |
| social | copy               | To capture a 'copy' share event.               |
| social | reddit             | To capture a 'reddit' share event.             |
| social | facebook messenger | To capture a 'facebook messenger' share event. |
| social | whatsapp           | To capture a 'whatsapp' share event.           |
| social | line               | To capture a 'line' share event.               |
| social | pinterest          | To capture a 'pinterest' share event.          |

{% tabs %}
{% tab title="Example Request" %}

```dart
await referralHeroService.captureShare('subscriberId', 'facebook');
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "id": "sub_a1d333c890bf",
        "name": "Test User 10",
        "email": "test15@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "33d278b9",
        "position": 21,
        "referred": false,
        "referred_by": {},
        "people_referred": 0,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1685018452,
        "points": 0,
        "risk_level": 0,
        "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic",
        "source": null,
        "device": null,
        "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic?mwr=33d278b9",
        "created_at": 1685018451,
        "last_updated_at": 1685018452,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=33d278b9",
        "status": "",
        "response": "subscriber_retrieved"
    },
    "calls_left": null,
    "timestamp": 1692865024
}
```

{% endtab %}
{% endtabs %}

## 10. Get My Referrals

This method is used for retrieving all referrals of the specific subscriber.

#### Path Parameters

| Name                                            | Type   | Description   |
| ----------------------------------------------- | ------ | ------------- |
| subscriber-id<mark style="color:red;">\*</mark> | String | Subscriber ID |

{% tabs %}
{% tab title="Example Request" %}

```dart
final referrals = await referralHeroService.getMyReferrals('subscriberId');
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "response": "subscribers_retrieved",
        "subscribers": [
            {
                "id": "sub_fa49ba0d30e9",
                "name": "Test User 10",
                "email": "test125@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "dededb46",
                "position": 18,
                "referred": true,
                "referred_by": {
                    "id": "sub_d0cc231dce89",
                    "name": "Test name",
                    "email": "test26@gmail.com",
                    "code": "0879561f",
                    "people_referred": 1,
                    "points": 0
                },
                "people_referred": 0,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1684985427,
                "points": 0,
                "risk_level": 0,
                "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic",
                "source": null,
                "device": null,
                "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic?mwr=dededb46",
                "created_at": 1684985427,
                "last_updated_at": 1684985427,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=dededb46",
                "status": "confirmed"
            }
        ],
        "pagination": {
            "total_pages": 1,
            "current_page": 1,
            "per_page": 50,
            "total_objects": 1
        }
    },
    "calls_left": null,
    "timestamp": 1692954116
}
```

{% endtab %}
{% endtabs %}

## 11. Get Leaderboard

This method is used for retrieving the campaign leaderboard.

{% tabs %}
{% tab title="Example Request" %}

```dart
final leaderboard = await referralHeroService.getLeaderboard();
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "ranking": [
            {
                "id": "sub_7b9be1ed8ccb",
                "name": "Test name new",
                "email": "test102@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "2c2dbefb",
                "position": 11,
                "referred": false,
                "referred_by": {},
                "people_referred": 3,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1685018462,
                "points": 0,
                "risk_level": 0,
                "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic",
                "source": null,
                "device": null,
                "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=2c2dbefb",
                "created_at": 1685018462,
                "last_updated_at": 1686575826,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=2c2dbefb",
                "status": ""
            },
            {
                "id": "sub_7797d0ec272e",
                "name": "",
                "email": "test786@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "9f234785",
                "position": 11,
                "referred": false,
                "referred_by": {},
                "people_referred": 2,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1686814646,
                "points": 0,
                "risk_level": 0,
                "host": "http://localhost:3000/legf4edsitimate",
                "source": null,
                "device": null,
                "referral_link": "http://localhost:3000/legf4edsitimate?mwr=9f234785",
                "created_at": 1686814646,
                "last_updated_at": 1686815029,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=9f234785",
                "status": ""
            },
            {
                "id": "sub_06e2af5a2236",
                "name": "Test User multi1",
                "email": "testorganic3@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "afd54225",
                "position": 11,
                "referred": false,
                "referred_by": {},
                "people_referred": 1,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1685018562,
                "points": 0,
                "risk_level": 0,
                "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic",
                "source": null,
                "device": null,
                "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic?mwr=afd54225",
                "created_at": 1685018562,
                "last_updated_at": 1686138321,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=afd54225",
                "status": ""
            },
            {
                "id": "sub_41adff0cfc8e",
                "name": "Test organic User1",
                "email": "testorganic1@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "23e0fb1c",
                "position": 1,
                "referred": true,
                "referred_by": {
                    "id": "sub_7b9be1ed8ccb",
                    "name": "Test name new",
                    "email": "test102@gmail.com",
                    "code": "2c2dbefb",
                    "people_referred": 3,
                    "points": 0
                },
                "people_referred": 1,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1685020506,
                "points": 0,
                "risk_level": 0,
                "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic",
                "source": null,
                "device": null,
                "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic?mwr=23e0fb1c",
                "created_at": 1685020506,
                "last_updated_at": 1688983405,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxxxx/universal_link?mwr=23e0fb1c",
                "status": "confirmed"
            },
            {
                "id": "sub_f9bb5d521d45",
                "name": "",
                "email": "test788@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "4646a17a",
                "position": 11,
                "referred": true,
                "referred_by": {
                    "id": "sub_7797d0ec272e",
                    "name": "",
                    "email": "test786@gmail.com",
                    "code": "9f234785",
                    "people_referred": 2,
                    "points": 0
                },
                "people_referred": 1,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1686814799,
                "points": 0,
                "risk_level": 0,
                "host": "http://localhost:3000/legitimate",
                "source": null,
                "device": null,
                "referral_link": "http://localhost:3000/legitimate?mwr=4646a17a",
                "created_at": 1686814799,
                "last_updated_at": 1686824516,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=4646a17a",
                "status": "confirmed"
            },
            {
                "id": "sub_1bb1e02b90cb",
                "name": "Pending Referral",
                "email": "testpending1@email.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "1b155f4e",
                "position": 11,
                "referred": true,
                "referred_by": {
                    "id": "sub_7b9be1ed8ccb",
                    "name": "Test name new",
                    "email": "test102@gmail.com",
                    "code": "2c2dbefb",
                    "people_referred": 3,
                    "points": 0
                },
                "people_referred": 0,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1685018482,
                "points": 0,
                "risk_level": 0,
                "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic",
                "source": null,
                "device": "IOS",
                "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=1b155f4e",
                "created_at": 1685018482,
                "last_updated_at": 1685707183,
                "os_type": "IOS",
                "screen_size": "64*32",
                "ip_address": "123.456.789.0123",
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=1b155f4e",
                "status": "confirmed"
            },
            {
                "id": "sub_e3a22f9c058e",
                "name": "Test User 10",
                "email": "test15@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "05d97b9c",
                "position": 11,
                "referred": true,
                "referred_by": {
                    "id": "sub_7b9be1ed8ccb",
                    "name": "Test name new",
                    "email": "test102@gmail.com",
                    "code": "2c2dbefb",
                    "people_referred": 3,
                    "points": 0
                },
                "people_referred": 0,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1685804120,
                "points": 0,
                "risk_level": 0,
                "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxxx/analytics/traffic",
                "source": null,
                "device": null,
                "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=05d97b9c",
                "created_at": 1685804120,
                "last_updated_at": 1685824588,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=05d97b9c",
                "status": "confirmed"
            },
            {
                "id": "sub_1745bc28a318",
                "name": "Test User 11",
                "email": "test11@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "0cdf62b6",
                "position": 2,
                "referred": true,
                "referred_by": {
                    "id": "sub_41adff0cfc8e",
                    "name": "Test organic User1",
                    "email": "testorganic1@gmail.com",
                    "code": "23e0fb1c",
                    "people_referred": 1,
                    "points": 0
                },
                "people_referred": 0,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1686138035,
                "points": 0,
                "risk_level": 0,
                "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic",
                "source": null,
                "device": null,
                "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=0cdf62b6",
                "created_at": 1686138035,
                "last_updated_at": 1688983288,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxx/universal_link?mwr=0cdf62b6",
                "status": "unconfirmed"
            },
            {
                "id": "sub_4056a6b27122",
                "name": "Test User 16",
                "email": "test16@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "7af598cb",
                "position": 11,
                "referred": true,
                "referred_by": {
                    "id": "sub_06e2af5a2236",
                    "name": "Test User multi1",
                    "email": "testorganic3@gmail.com",
                    "code": "afd54225",
                    "people_referred": 1,
                    "points": 0
                },
                "people_referred": 0,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1686138073,
                "points": 0,
                "risk_level": 0,
                "host": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic",
                "source": null,
                "device": null,
                "referral_link": "https://app.referralhero.com/dashboard/lists/MFxxxxxxxxx/analytics/traffic?mwr=7af598cb",
                "created_at": 1686138073,
                "last_updated_at": 1686138319,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxx/universal_link?mwr=7af598cb",
                "status": "confirmed"
            },
            {
                "id": "sub_637a4521548a",
                "name": "",
                "email": "test787@gmail.com",
                "phone_number": "",
                "crypto_wallet_address": "",
                "crypto_wallet_provider": "",
                "extra_field": "",
                "extra_field_2": "",
                "option_field": "",
                "conversion_amount": 0.0,
                "code": "1e42e41f",
                "position": 11,
                "referred": true,
                "referred_by": {
                    "id": "sub_7797d0ec272e",
                    "name": "",
                    "email": "test786@gmail.com",
                    "code": "9f234785",
                    "people_referred": 2,
                    "points": 0
                },
                "people_referred": 0,
                "promoted": false,
                "promoted_at": null,
                "verified": true,
                "verified_at": 1686814728,
                "points": 0,
                "risk_level": 0,
                "host": "http://localhost:3000/legf4edsitimate",
                "source": null,
                "device": null,
                "referral_link": "http://localhost:3000/legf4edsitimate?mwr=1e42e41f",
                "created_at": 1686814728,
                "last_updated_at": 1686815033,
                "os_type": null,
                "screen_size": null,
                "ip_address": null,
                "universal_link": "https://app.referralhero.com/MFxxxxxxxxxx/universal_link?mwr=1e42e41f",
                "status": "confirmed"
            }
        ],
        "count": 10
    },
    "calls_left": null,
    "timestamp": 1692954943
}
```

{% endtab %}
{% endtabs %}

## 12. Get Referrer

This method is used to retrieve the referrer of a user. By calling this method, you would know if someone was a referral or not, and then could:

* Apply a discount code automatically to the checkout process
* Personalize text shown on a page

{% tabs %}
{% tab title="Example Request" %}

```dart
final query = {
  "email": signup_email?.text, //Optional value, capture this from user
  "name": signup_name?.text, //Optional value, capture this from user
  "ip_address": referralHeroService.deviceInfo.getIpAddress(), //Required value
  "os_type": referralHeroService.deviceInfo.getOperatingSystem(), //Required value
  "screen_size": referralHeroService.deviceInfo.getDeviceScreenSize(), //Required value
  "device": referralHeroService.deviceInfo.getDeviceType(), //Required value
};

final referrer = await referralHeroService.getReferrer(query);
```

{% endtab %}

{% tab title="Example Response" %}

```json
{
    "status": "ok",
    "data": {
        "id": "sub_68c9ed9e2712",
        "name": "test one",
        "email": "test1@gmail.com",
        "phone_number": "",
        "crypto_wallet_address": "",
        "crypto_wallet_provider": "",
        "extra_field": "",
        "extra_field_2": "",
        "option_field": "",
        "conversion_amount": 0.0,
        "code": "00598133",
        "position": 2,
        "referred": false,
        "referred_by": {},
        "people_referred": 1,
        "promoted": false,
        "promoted_at": null,
        "verified": true,
        "verified_at": 1686310876,
        "points": 0,
        "risk_level": 0,
        "host": "https://app.referralhero.com",
        "source": null,
        "device": null,
        "referral_link": "https://app.referralhero.com?mwr=00598133",
        "created_at": 1686310876,
        "last_updated_at": 1692824465,
        "os_type": null,
        "screen_size": null,
        "ip_address": null,
        "universal_link": "https://app.referralhero.com/MFxxxxxxxxxxx/universal_link?mwr=00598133",
        "status": "",
        "response": "subscriber_retrieved"
    },
    "calls_left": null,
    "timestamp": 1692957166
}
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
NOTE:

The mobile parameters must be sent in the correct format for our system to automatically identify a referral. See the Getting Started section [here](https://support.referralhero.com/integrate/mobile-sdks/getting-started#tracking-referrals).
{% endhint %}

## 13. Get Rewards

Use this method to Get Rewards unlocked by a specific subscriber.

| Name                                            | Type   | Description   |
| ----------------------------------------------- | ------ | ------------- |
| subscriber-id<mark style="color:red;">\*</mark> | String | Subscriber ID |

{% tabs %}
{% tab title="Example Request" %}

```dart
final rewards = await referralHeroService.getRewards('subscriberId');
```

{% endtab %}

{% tab title="Example Response" %}

```javascript
{
    "status": "ok",
    "data": {
        "response": "rewards_retrieved",
        "rewards": [
            {
                "id": 1795,
                "name": "A free Premium account for 1 year",
                "status": "confirmed",
                "referrals": null,
                "created_at": 1686397951,
                "signup_type": "organic subscriber",
                "referrals_type": null,
                "recurring_count": null,
                "image_url": null
            }
        ],
        "pagination": {
            "total_pages": 1,
            "current_page": 1,
            "per_page": 10,
            "total_objects": 1
        }
    },
    "calls_left": null,
    "timestamp": 1687759997
}
```

{% endtab %}
{% endtabs %}