Update Commision

PUT

/commissions

Last modified:2025-12-30 08:50:18

Updates an existing commission record using its unique identifier.

This endpoint allows modification of commission details such as amounts, referred user, status, and remarks. It is typically used to mark commissions as processing, paid, or refunded, or to correct commission data.

Request

Query Params

Header Params

Body Params application/json

Example

{
    "campaignId": "a4845c6c-297b-4e1f-92d6-db7ca2ac5200",
    "affiliateId": "d3a1153d-cb87-4644-8429-7ecf1a7c3257",
    "referredUser": "updated@example.com",
    "amount": 50.00,
    "adminEarnedAmount": 5.00,
    "status": "pending",
    "commissionDate": "2025-01-15T00:00:00.000Z",
    "remarks": "Updated commission for referral"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/commissions?commissionId=725cf3e1-c61d-4c3e-902d-6cdd5bbf7ee6' \
--header 'x-auth-referralstack: rs_live_e6761c15744c9be53be18802278fd3da751d03ce' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaignId": "a4845c6c-297b-4e1f-92d6-db7ca2ac5200",
    "affiliateId": "d3a1153d-cb87-4644-8429-7ecf1a7c3257",
    "referredUser": "updated@example.com",
    "amount": 50.00,
    "adminEarnedAmount": 5.00,
    "status": "pending",
    "commissionDate": "2025-01-15T00:00:00.000Z",
    "remarks": "Updated commission for referral"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Commission updated successfully",
    "data": {
        "commissionId": "25e187c1-d732-4d7e-9245-a52253f65a7e",
        "campaignId": "a4845c6c-297b-4e1f-92d6-db7ca2ac5200",
        "workspaceId": "5bb8cbe6-67dc-4b07-853e-7ca5454f8512",
        "affiliateId": "d3a1153d-cb87-4644-8429-7ecf1a7c3257",
        "referredUser": "updated@example.com",
        "amount": 50,
        "adminEarnedAmount": 5,
        "status": "pending",
        "createdAt": "2025-12-30T03:00:04.440Z",
        "updatedAt": "2025-12-30T08:48:58.682Z"
    }
}

🟠400Bad request (Missing CommissionId)

🟠401Unauthorized (Missing API Key)

Modified at 2025-12-30 08:50:18

Create Commision

Delete Commision