Update Affiliate Terms

Update existing affiliate contract terms

POST https://platform.shoffi.app/API/affiliate/updateAffiliateTerms

Request Body

Name	Type	Description
apiKey*	String	Your Shoffi app API Key
appId*	Integer	Your app ID
affiliateTerms*	Object	New affiliate contract terms
email*	String	The affiliate email address

200: OK

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

400: Bad Request

curl -X POST \
  https://platform.shoffi.app/API/affiliate/updateAffiliateTerms \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "YourKey",
    "appId": 00000000,
    "email": "[email protected]",
    "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.

• 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

200 OK
Content-Type: application/json

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