> For the complete documentation index, see [llms.txt](https://docs.shoffi.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shoffi.app/the-shoffi-api/add-bonus-reward.md).

# Add Bonus Reward

## Add a bonus reward to an affiliate

<mark style="color:green;">`POST`</mark> `https://platform.shoffi.app/API/affiliate/addBonusReward`

Use this endpoint to reward an affiliate with a one-time bonus commission.

#### Request Body

| Name                                     | Type    | Description                          |
| ---------------------------------------- | ------- | ------------------------------------ |
| apiKey<mark style="color:red;">\*</mark> | String  | Your Shoffi app API Key              |
| appId<mark style="color:red;">\*</mark>  | Integer | Your app ID                          |
| email<mark style="color:red;">\*</mark>  | String  | The affiliate email address          |
| amount<mark style="color:red;">\*</mark> | Integer | Bonus reward amount (USD)            |
| internalNote                             | String  | Internal note (for your own records) |

{% tabs %}
{% tab title="200: OK " %}

```json
{
  "bonusReward": {
    "email": "tobias@lutke.com",
    "amount": 100,
    "internalNote": "Bonus for Q4 campaign"
  }
}
```

{% endtab %}

{% tab title="400: Bad Request " %}

```json
{
  "status": 400,
  "message": "Error details"
}
```

{% endtab %}
{% endtabs %}

```bash
curl -X POST \
  https://platform.shoffi.app/API/affiliate/addBonusReward \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "YourKey",
    "appId": 00000000,
    "email": "tobias@lutke.com",
    "amount": 100,
    "internalNote": "Bonus for Q4 campaign"
}'
```

## Parameter breakdown

* `email:`\
  The affiliate email address.
* `amount:`\
  The bonus reward amount to add.
* `internalNote:`\
  Optional internal note (not shown to the affiliate).

## Response example

```json
200 OK
Content-Type: application/json
```

```json
{
  "bonusReward": {
    "email": "tobias@lutke.com",
    "amount": 100,
    "internalNote": "Bonus for Q4 campaign"
  }
}
```