SellApp
ApiResourcesAffiliates

Update affiliate payout status

Atomically settle or reopen an affiliate payout and all linked referrals.

The payout amount is verified against its linked referral total before the transition. Identical retries do not add history or duplicate accounting.

PATCH
/v2/affiliate-payouts/{payout}/status

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

payout*integer

The payout path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://sell.app/api/v2/affiliate-payouts/0/status" \  -H "Content-Type: application/json" \  -d '{    "status": "due"  }'
{
  "data": {
    "id": 0,
    "affiliate_id": 0,
    "affiliate_email": "user@example.com",
    "amount_usd_cents": 0,
    "status": "due",
    "payout_method": "string",
    "payout_account": "string",
    "referrals_count": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}