---
title: "Updates the custom field definition with the specified id."
method: PUT
path: "/customfielddefinitions/{customFieldDefinitionId}"
tags: ["customFields"]
---

# Updates the custom field definition with the specified id.

`PUT /customfielddefinitions/{customFieldDefinitionId}`

<Check title="Required Permissions" icon="key">The user must be an admin or have `project-manage-config:write` permissions.</Check>

## Path parameters

- `customFieldDefinitionId` string, uuid, required

## Headers

- `Authorization` string, required

## Request body

- CustomFieldDefinitionPutForm
  - `name` string, required — The name of the custom field definition.
  - `type` 'text' | 'number' | 'date' | 'datetime' | 'select' | 'coloredSelect' | 'link' | 'boolean' | 'user' | 'client', required — The type of the custom field definition. When updating a custom field definition, only the following changes are allowed: 'date' ↔ 'datetime', 'select' ↔ 'coloredSelect'.
  - `order` number, double, nullable — The global (workspace-level) order of the custom field definition. Only project custom field definitions have a global order.

## Response `200`

OK

- CustomFieldDefinition
  - `id` string, uuid — The id of the custom field definition.
  - `name` string, nullable — The name of the custom field definition.
  - `entity` 'task' | 'project' — The entity the custom field definition can be linked to.
  - `type` 'text' | 'number' | 'date' | 'datetime' | 'select' | 'coloredSelect' | 'link' | 'boolean' | 'user' | 'client' — The type of the custom field definition.
  - `createdOn` string, date-time — The date this entity was created.
  - `createdBy` string, uuid — The id of the user who created this entity.
  - `updatedOn` string, date-time — The date this entity was last modified.
  - `updatedBy` string, uuid — The id of the user who last modified this entity.
  - `order` number, double, nullable — If it's a project custom field, it's the global order of the custom field definition. Otherwise, it's the order of the custom field definition within a project template or a project.
  - `isExternal` boolean — True if this entity is coming from an external workspace (awork Connect).

## Other responses

- `400` — Bad Request
- `404` — Not Found

---

[API](https://skmtc.net/awork-io/apis/api-v1-reference.md) · [All operations](https://skmtc.net/awork-io/apis/api-v1-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/awork-io/api-v1-reference/versions/f784a53f60df/schema)