Skip to main content

Archive Evaluation Field (v1)

Method + Path

POST /v1/workspace/:workspaceId/sessions/evaluation-fields/:fieldId/archive

Actual backend path: /v1/workspace/:workspaceId/sessions/evaluation-fields/:fieldId/archive

Description

Archive an evaluation field definition. Archived fields are hidden by default but can be restored later.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • sessions.update

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier
fieldIdstringYesField identifier

Response (200)

{
"field": {
"id": "507f1f77bcf86cd799439011",
"key": "satisfaction-rating",
"label": "Satisfaction Rating",
"status": "archived",
"archivedAt": "2024-01-15T11:00:00Z"
}
}

Common Errors

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