# 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 " %}

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

{% endtab %}
{% endtabs %}

```
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"
}'
```

## Parameters 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"
  }
}
```


---

# 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://docs.shoffi.app/the-shoffi-api/add-bonus-reward.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.