Skip to main content

Restore Client Field (v1)

Method + Path

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

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

Description

Restore an archived custom field definition. The field will become active again.

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 (200)

{
"field": {
"id": "507f1f77bcf86cd799439011",
"key": "notes",
"label": "Notes",
"status": "active",
"restoredAt": "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