Referrals

Referral system management

Generate referral invitation

post

https://dev-api.joy.sohttps://api.joy.so

/rest_api/v2/referrals/invitations

Create a new referral invitation link for a customer

Body

application/json

emailstring · emailRequired

Responses

200

Invitation generated successfully

application/json

successbooleanOptionalExample: true

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptionalExample: Operation completed successfully

timestampstring · date-timeOptionalExample: 2023-07-28T07:27:54.123Z

post

/rest_api/v2/referrals/invitations

HTTPcURLJavaScriptPython

POST /rest_api/v2/referrals/invitations HTTP/1.1
Host: dev-api.joy.so
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

200

Invitation generated successfully

{
  "success": true,
  "data": {
    "inviteLink": "text",
    "referralCode": "text"
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Get customer referrers

get

https://dev-api.joy.sohttps://api.joy.so

/rest_api/v2/referrals/customers/{customerId}/referrers

Retrieve list of customers who referred this customer

Path parameters

customerIdstringRequired

Customer ID

Responses

200

List of referrers

application/json

successbooleanOptionalExample: true

dataobject[]Optional

messagestringOptionalExample: Operation completed successfully

timestampstring · date-timeOptionalExample: 2023-07-28T07:27:54.123Z

get

/rest_api/v2/referrals/customers/{customerId}/referrers

HTTPcURLJavaScriptPython

GET /rest_api/v2/referrals/customers/{customerId}/referrers HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200

List of referrers

{
  "success": true,
  "data": [
    {}
  ],
  "meta": {
    "count": 1
  },
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Get customer referral summary

get

https://dev-api.joy.sohttps://api.joy.so

/rest_api/v2/referrals/customers/{customerId}/summary

Retrieve comprehensive referral statistics for a customer

Path parameters

customerIdstringRequired

Customer ID

Responses

200

Referral summary

application/json

successbooleanOptionalExample: true

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptionalExample: Operation completed successfully

timestampstring · date-timeOptionalExample: 2023-07-28T07:27:54.123Z

get

/rest_api/v2/referrals/customers/{customerId}/summary

HTTPcURLJavaScriptPython

GET /rest_api/v2/referrals/customers/{customerId}/summary HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200

Referral summary

{
  "success": true,
  "data": {
    "totalRedeemCoupon": 1,
    "totalPointEarnRefer": 1
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Get referral analytics

get

https://dev-api.joy.sohttps://api.joy.so

/rest_api/v2/referrals/analytics

Retrieve referral program analytics and performance metrics

Query parameters

startDatestring · dateOptional

endDatestring · dateOptional

Responses

200

Referral analytics data

application/json

successbooleanOptionalExample: true

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptionalExample: Operation completed successfully

timestampstring · date-timeOptionalExample: 2023-07-28T07:27:54.123Z

get

/rest_api/v2/referrals/analytics

HTTPcURLJavaScriptPython

GET /rest_api/v2/referrals/analytics HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200

Referral analytics data

{
  "success": true,
  "data": {
    "countCouponCodeUsage": 1
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}