Skip to main content

Delete Referral (v1)

Method & Path​

DELETE /api/v1/admin/referrals/:referralId

Description​

Delete an admin referral. Linked workspaces will have their referral cleared.

Backend path: /v1/admin/referrals/:referralId

Authentication​

Required: Admin authentication with businesses.manage permission.

Authorization: Bearer <admin_token>

Headers​

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

Path Parameters​

ParameterTypeRequiredDescription
referralIdstringYesReferral ID

Request Body​

None.

Response 200 OK​

{
  "message": "Referral deleted successfully."
}

Common Errors​

  • 400 Bad Request: Invalid referral ID
  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Referral not found
  • 500 Internal Server Error: Server error