Skip to main content

Delete Referral (v1)

Method & Path

DELETE /api/v1/workspace/:workspaceId/referrals/:referralId

Actual backend path: /v1/workspace/:workspaceId/referrals/:referralId

Description

Delete a referral from a workspace.

Authentication

Required: Workspace authentication with appropriate permissions.

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
referralIdstringYesReferral identifier

Response 204 No Content

The response body is empty.

Common Errors

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