Update Referred User

PUT

/referred-users

Last modified:2025-12-30 10:53:04

Updates an existing referred user record in the affiliate system.

This endpoint allows you to modify referral details such as the commission amount, current status, add remarks, link to invoices, or update processing timestamps. Use this to maintain accurate referral records as they progress through your workflow.

All fields that were used during creation can be updated, including the affiliate ID, campaign ID and Stripe ID's.

Request

Query Params

Header Params

Body Params application/json

Example

{
    "name": "John Doe",
    "remarks": "Updated commission for referral",
    "isSelfReferral": true,
    "invoiceId": null
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/referred-users?referredUser=user@example.com' \
--header 'x-auth-referralstack: rs_live_e6761c15744c9be53be18802278fd3da751d03ce' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "John Doe",
    "remarks": "Updated commission for referral",
    "isSelfReferral": true,
    "invoiceId": null
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Referred user updated successfully",
    "data": {
        "commissionId": "5338c0f0-f7f0-4ae9-bd0f-cd427a024b62",
        "referredUser": "user@example.com",
        "affiliateId": "d3a1153d-cb87-4644-8429-7ecf1a7c3257",
        "workspaceId": "5bb8cbe6-67dc-4b07-853e-7ca5454f8512",
        "campaignId": "a4845c6c-297b-4e1f-92d6-db7ca2ac5200",
        "amount": "50.00",
        "adminEarnedAmount": "5.00",
        "status": "pending",
        "payoutDate": null,
        "name": null,
        "remarks": "Updated commission for referral",
        "isSelfReferral": false,
        "isWalletPayment": 0,
        "chargeId": null,
        "invoiceId": null,
        "stripeSubscriptionId": null,
        "createdAt": "2025-12-30T04:57:37.970Z",
        "updatedAt": "2025-12-30T05:18:54.488Z"
    }
}

🟠400Bad request

🟠401Unauthorized (Missing API Key)

Modified at 2025-12-30 10:53:04

Create Referred User

Delete Referred User