---
title: "Update custom field on workspace"
method: PUT
path: "/v1/workspaces/{workspaceId}/custom-fields/{customFieldId}"
tags: ["Custom fields"]
---

# Update custom field on workspace

`PUT /v1/workspaces/{workspaceId}/custom-fields/{customFieldId}`

## Path parameters

- `workspaceId` string, required — Represents a workspace identifier across the system.
- `customFieldId` string, required — Represents a custom field identifier across the system.

## Request body

- UpdateCustomFieldRequestV1
  - `allowedValues` string[] — Represents a list of custom field's allowed values. If field type is not `DROPDOWN_SINGLE` or `DROPDOWN_MULTIPLE`, the values provided will be ignored by the server.
  - `description` string — Represents a custom field description.<br/>If this field is not included in the payload,it will automatically be set to `null`
  - `name` string, required — Represents a custom field name.
  - `onlyAdminCanEdit` boolean — Flag to set whether custom field is modifiable only by admin users.
  - `placeholder` string — Represents a custom field placeholder value.<br/>If this field is not included in the payload,it will automatically be set to `null`.
  - `required` boolean — Flag to set whether custom field is mandatory or not.
  - `status` 'INACTIVE' | 'VISIBLE' | 'INVISIBLE' — Represents a custom field status.<br/>If this field is not included in the payload,it will automatically be set to default `INACTIVE`.
  - `type` 'TXT' | 'NUMBER' | 'DROPDOWN_SINGLE' | 'DROPDOWN_MULTIPLE' | 'CHECKBOX' | 'LINK' — Represents a custom field type. This field is now deprecated and it's value will be ignored by the server. It will be removed entirely in a future release. Please stop including it in your payloads. To change a custom field type, please create a new object with the desired type instead.
  - `workspaceDefaultValue` object — Represents a custom field's default value in the workspace.<li>if type = NUMBER, then value must be a number</li><li>if type = DROPDOWN_MULTIPLE, value must be a list</li><li>if type = CHECKBOX, value must be true/false</li><li>otherwise any string</li>

## Response `200`

OK

- CustomFieldDtoV1
  - `allowedValues` string[] — Represents a list of custom field's allowed values.
  - `description` string — Represents custom field description.
  - `entityType` string — Represents custom field entity type
  - `id` string — Represents custom field identifier across the system.
  - `name` string — Represents custom field name.
  - `onlyAdminCanEdit` boolean — Flag to set whether custom field is modifiable only by admin users.
  - `placeholder` string — Represents custom field placeholder value.
  - `projectDefaultValues` CustomFieldDefaultValuesDtoV1[] — Represents a list of custom field default values data transfer objects.
    - `projectId` string — Represents project identifier across the system.
    - `status` string — Represents custom field status
    - `value` object — Represents a custom field's default value
  - `required` boolean — Flag to set whether custom field is mandatory or not.
  - `status` string — Represents custom field status
  - `type` string — Represents custom field type.
  - `workspaceDefaultValue` object — Represents a custom field's default value in the workspace.
  - `workspaceId` string — Represents workspace identifier across the system.

---

[API](https://skmtc.dev/clockify/apis/clockify-api.md) · [All operations](https://skmtc.dev/clockify/apis/clockify-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/clockify/clockify-api/revisions/a5b636acbcd8/schema)