Skip to main content

Delete Client Field (v1)

Method + Path

DELETE /v1/workspace/:workspaceId/clients/fields/:fieldId

Actual backend path: /v1/workspace/:workspaceId/clients/fields/:fieldId

Description

Permanently delete a custom field definition for clients. This action cannot be undone.

caution

Deleting a field will remove it from all clients. This action is irreversible.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • clients.update

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
fieldIdstringYesField identifier

Response (204)

No content - successful deletion.

Common Errors

  • 401 Unauthorized: Missing or invalid authentication token
  • 403 Forbidden: Insufficient permissions (requires clients.update)
  • 404 Not Found: Field or workspace not found
  • 500 Internal Server Error: Server error