API v1 ReferenceCustom Fields

Updates the custom field definition with the specified id.

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

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
idstringformat: "uuid"
The id of the custom field definition.
namestring or null
The name of the custom field definition.
entityenum
The entity the custom field definition can be linked to.
typeenum
The type of the custom field definition.
createdOnstringformat: "date-time"
The date this entity was created.
createdBystringformat: "uuid"
The id of the user who created this entity.
updatedOnstringformat: "date-time"
The date this entity was last modified.
updatedBystringformat: "uuid"
The id of the user who last modified this entity.
orderdouble or null
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.
isExternalboolean

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

Errors

400
Bad Request Error
404
Not Found Error