Skip to navigation
API v1 ReferenceCustom Fields

Updates the specified custom field definition.

Updates the definition’s name, type, or order. Type changes are limited to compatible date and date-time types or select and colored-select types.

Required Permissions
The user must be an admin or have project-manage-config:write permissions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customFieldDefinitionIdstringRequiredformat: "uuid"
The id of the custom field definition to update.

Request

The model to change the custom field definition.
namestringRequired1-255 characters
The name of the custom field definition.
typeenumRequired

The type of the custom field definition. When updating a custom field definition, only the following changes are allowed: 'date' ↔ 'datetime', 'select' ↔ 'coloredSelect'.

orderdouble or nullOptional

The global (workspace-level) order of the custom field definition. Only project custom field definitions have a global order.

Response

OK
idstringOptionalformat: "uuid"
The id of the custom field definition.
namestring or nullOptional
The name of the custom field definition.
entityenumOptional
The entity the custom field definition can be linked to.
Allowed values:
typeenumOptional
The type of the custom field definition.
createdOnstringOptionalformat: "date-time"
The date this entity was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this entity.
updatedOnstringOptionalformat: "date-time"
The date this entity was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this entity.
orderdouble or nullOptional
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.
isExternalbooleanOptional

True if this entity is coming from an external workspace (awork Connect).

Errors

400
Bad Request Error
404
Not Found Error