customFields

Updates the specified custom field definition.

Changed on

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.

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

put/customfielddefinitions/{customFieldDefinitionId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/customfielddefinitions/{customFieldDefinitionId}
  • Auth: HTTP bearer

Path parameters

customFieldDefinitionIdstring uuid required

The id of the custom field definition to update.

Request body

namestring 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'.

ordernumber double nullable

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

Response

OK

idstring uuid

The id of the custom field definition.

namestring 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.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

ordernumber 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.

isExternalboolean

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutCustomFieldDefinitionById removed and replaced with customFields_PutCustomFieldDefinitionById