Update Client Field (v1)

Method + Path

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

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

Description

Update an existing custom field definition for clients. All fields are optional - only provided fields will be updated.

Authentication

Required - JWT token in Authorization header

Required Permissions:

• clients.update

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token: Bearer <token>
Content-Type	string	Yes	application/json

Path Parameters

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

Request Body

{
  "label": "Updated Notes",
  "description": "Updated description",
  "isRequired": true,
  "isFilterable": false
}

Body Parameters

Parameter	Type	Required	Description
label	string	No	Display label for the field
description	string	No	Field description
isRequired	boolean	No	Whether the field is required
isUnique	boolean	No	Whether field values must be unique
isFilterable	boolean	No	Whether the field can be used for filtering
metadata	object	No	Additional metadata for the field

Response (200)

{
  "field": {
    "id": "507f1f77bcf86cd799439011",
    "key": "notes",
    "label": "Updated Notes",
    "description": "Updated description",
    "type": "text",
    "isRequired": true,
    "isUnique": false,
    "isFilterable": false,
    "order": 1,
    "updatedAt": "2024-01-15T11:00:00Z"
  }
}

Common Errors

• 400 Bad Request: Invalid request body
• 401 Unauthorized: Missing or invalid authentication token
• 403 Forbidden: Insufficient permissions (requires clients.update)
• 404 Not Found: Field or workspace not found
• 422 Unprocessable Entity: Validation errors
• 500 Internal Server Error: Server error