# Update Affiliate Terms

## Update existing affiliate contract terms

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

#### 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                  |
| affiliateTerms<mark style="color:red;">\*</mark> | Object  | New affiliate contract terms |
| email<mark style="color:red;">\*</mark>          | String  | The affiliate email address  |

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

```json
{
    "affiliateNewTerms": {
        "revenueShare": 50,
        "cpi": 10,
        "limitPeriod": 24,
        "minWithdrawal": 50
    }
}
```

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

```
curl -X POST \
  https://platform.shoffi.app/API/affiliate/updateAffiliateTerms \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "YourKey",
    "appId": 00000000,
    "email": "tobias@lutke.com",
    "affiliateTerms": {
        "revenueShare": 50,
        "cpi": 10,
        "limitPeriod": 24,
        "minWithdrawal": 50,
        "recurringChargeOnly": false
    }
}'
```

## Parameters breakdown

### affiliateTerms

* `revenueShare:`\
  The percentage you are willing to pay the affiliate for every transaction made by a store they referred to. You can read more about [the affiliate commission](/general/the-affiliate-commission.md).
* `cpi:`\
  Cost Per Install. The amount the affiliate will be rewarded for each successful install of the app. You can set the amount to '0' if you are not interested in paying per install.
* `limitPeriod:`\
  The period in which the affiliate will earn commissions from transactions made by the referred store, In months. If not limited, the affiliate will earn commissions as long as the referral is active.
* `minWithdrawal:`\
  The minimum amount an affiliate needs to reach in earnings so they can ask to withdraw their balance. In USD.
* `recurringChargeOnly:`\
  Apply affiliate earnings from recurring charges only, excluding one-time fees charged by the app.

## Response example

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

```json
{
    "affiliateNewTerms": {
        "revenueShare": 50,
        "cpi": 10,
        "limitPeriod": 24,
        "minWithdrawal": 50,
        "recurringChargeOnly": false
    }
}
```


---

# 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/update-affiliate-terms.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.