Creates a new custom field definition. | awork API

curl -X POST https://api.awork.com/api/v1/customfielddefinitions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Ticket-Number",
  "type": "text",
  "entity": "task"
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Ticket-Number",
  "entity": "task",
  "type": "text",
  "createdOn": "2022-03-10T16:25:09.100Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedOn": "2022-03-10T18:55:00.500Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "order": 1,
  "isExternal": true,
  "selectionOptions": [
    {
      "value": "Website Design",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "color": "purple",
      "order": 0
    }
  ]
}

Creates a new custom field definition. This custom field definition can then be linked to project templates and to tasks.

Required Permissions

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

Creates a new custom field definition. This custom field definition can then be linked to project templates and to tasks. <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.

Request

The model containing the details for creating a new custom field definition.

namestringRequired1-255 characters

The name of the custom field definition.

typeenumRequired

The type of the custom field definition.

entityenumRequired

The entity the custom field definition can be linked to.

Allowed values:

selectionOptionslist of objects or nullOptional

The selection options for the custom field definition. Can only be used if the type is 'select'.

orderdouble or nullOptional

The order of the custom field definition. This value is only used (and required) if the entity is ‘project’, as the project custom field definitions are globally ordered. To set the order for task custom field definitions, use the endpoint to update the order of a custom field definition for a project/project template.

Response

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.

Allowed values:

typeenum

The type of the custom field definition.

createdOndatetime

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOndatetime

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

selectionOptionslist of objects or null

The selection options for this custom field definition.

Errors

400

Bad Request Error