Archive Client Field (v1)

Method + Path

POST /v1/workspace/:workspaceId/clients/fields/:fieldId/archive

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

Description

Archive a custom field definition. Archived fields are hidden by default but can be restored later.

Authentication

Required - JWT token in Authorization header

Required Permissions:

• clients.update

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token: Bearer <token>

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier
fieldId	string	Yes	Field identifier

Response (200)

{
  "field": {
    "id": "507f1f77bcf86cd799439011",
    "key": "notes",
    "label": "Notes",
    "status": "archived",
    "archivedAt": "2024-01-15T11:00:00Z"
  }
}

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