API v1 ReferenceCustom Fields

Updates a custom field selection option for an existing custom field definition.

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

Path parameters

customFieldDefinitionIdstringRequiredformat: "uuid"
The id of the custom field definition.
selectionOptionIdstringRequiredformat: "uuid"
The id of the selection option.

Request

The form to update the custom field selection option.
valuestringRequired>=1 character<=255 characters
The selection value which can be used in a select custom field.
orderdoubleRequired
The order of the custom field selection option.
colorenum or nullOptional
The color of the selection option.

Response

OK
idstring or nullformat: "uuid"
The id of the custom field definition.
namestring or null
The name of the custom field definition.
entityenum or null
The entity the custom field definition can be linked to.
Allowed values:
typeenum or null
The type of the custom field definition.
createdOnstring or nullformat: "date-time"
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOnstring or nullformat: "date-time"
The date this entity was last modified.
updatedBystring or nullformat: "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 or null

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