Updates an existing custom field definition with the specified id. — awork API

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

Path parameters

customFieldDefinitionIdstringRequired

The id of the custom field definition.

Request

This endpoint expects an object.

namestringRequired>=1 character<=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’.

Response

idstringOptional

The id of the custom field definition.

namestringOptional

The name of the custom field definition.

entity"task"OptionalDefaults to task

The entity the custom field definition can be linked to.

typeenumOptional

The type of the custom field definition.

createdOndatetimeOptional

The date this entity was created.

createdBystringOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedBystringOptional

The id of the user who last modified this entity.

1	curl -X PUT https://api.awork.com/api/v1/customfielddefinitions/customFieldDefinitionId \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Ticket-Number",
6	"type": "text"
7	}'

1	{
2	"id": "123e4567-e89b-12d3-a456-426614174000",
3	"name": "Ticket-Number",
4	"entity": "task",
5	"type": "text",
6	"createdOn": "2022-03-10T16:25:09Z",
7	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
8	"updatedOn": "2022-03-10T18:55:00Z",
9	"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
10	}