Skip to main content

Create Referral (v1)

Method & Path​

POST /api/v1/admin/referrals

Description​

Create a new admin referral.

Backend path: /v1/admin/referrals

Authentication​

Required: Admin authentication with businesses.manage permission.

Authorization: Bearer <admin_token>

Headers​

Authorization: Bearer <admin_token>
Content-Type: application/json

Request Body​

{
  "name": "Ahmed Ali",
  "phone": "0599123456",
  "sharePercentage": 10
}
FieldTypeRequiredDescription
namestringYesReferral name
phonestringYesReferral phone number
sharePercentagenumberYesShare percentage (0-100)

Response 201 Created​

{
  "referral": {
    "id": "65f1c1a2b3c4d5e6f7a8b901",
    "name": "Ahmed Ali",
    "phone": "0599123456",
    "sharePercentage": 10,
    "createdBy": "65aab1c2d3e4f5a6b7c8d901",
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2025-01-15T10:00:00.000Z"
  }
}

Common Errors​

  • 400 Bad Request: Validation error
  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions
  • 500 Internal Server Error: Server error