Create Referred User

POST

/referred-users

Last modified:2025-12-30 10:40:38

Creates a new referred user record in the affiliate system.

This endpoint registers a user who has signed up through an affiliate referral link, linking them to the referring affiliate and campaign. Use this to track new sign-ups that originated from affiliate marketing efforts.

Request

Header Params

Body Params application/json

Example

{
  "referredTo": "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": "Manual commission for referral",
  "isSelfReferral": false,
  "isWalletPayment": 0,
  "chargeId": null,
  "invoiceId": null,
  "stripeSubscriptionId": null,
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/referred-users' \
--header 'x-auth-referralstack: rs_live_e6761c15744c9be53be18802278fd3da751d03ce' \
--header 'Content-Type: application/json' \
--data-raw '{
  "referredTo": "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": "Manual commission for referral",
  "isSelfReferral": false,
  "isWalletPayment": 0,
  "chargeId": null,
  "invoiceId": null,
  "stripeSubscriptionId": null,
}'

Responses

🟢201Success

application/json

Body

Example

{
    "status": 201,
    "message": "Referred user created 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": "Manual commission for referral",
        "isSelfReferral": false,
        "isWalletPayment": 0,
        "chargeId": null,
        "invoiceId": null,
        "stripeSubscriptionId": null,
        "createdAt": "2025-12-30T04:57:37.970Z",
        "updatedAt": "2025-12-30T04:57:37.970Z"
    }
}

🟠400Bad request

🟠401Unauthorized (Missing API Key)

Modified at 2025-12-30 10:40:38

Get Referred User by Email

Update Referred User