Approve or reject a flagged referral

PATCH/v1/referral/admin/referrals/{referralId}/review

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

referralIdstringrequired

Request body

requiredapplication/json

actionstringrequired

notesstring

Responses

200OK

created_atstringrequired

fraud_bandstringrequired

fraud_reasonsstring[] | nullrequired

fraud_scoreinteger<int64>required

fraud_statusstringrequired

idstringrequired

referee_emailstringrequired

referee_namestringrequired

referral_codestringrequired

referrer_emailstringrequired

referrer_namestringrequired

statusstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PATCH "/v1/referral/admin/referrals/string/review" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "string",
  "notes": "string"
}'

const response = await fetch("/v1/referral/admin/referrals/string/review", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "action": "string",
  "notes": "string"
})
});

import requests

response = requests.patch(
    "/v1/referral/admin/referrals/string/review",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "action": "string",
  "notes": "string"
},
)

Response

{
  "created_at": "string",
  "fraud_band": "string",
  "fraud_reasons": [
    "string"
  ],
  "fraud_score": 0,
  "fraud_status": "string",
  "id": "string",
  "referee_email": "string",
  "referee_name": "string",
  "referral_code": "string",
  "referrer_email": "string",
  "referrer_name": "string",
  "status": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}