API v1 ReferenceCustom Fields

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

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

Path parameters

customFieldDefinitionIdUUIDRequired
The id of the custom field definition.
selectionOptionIdUUIDRequired
The id of the selection option.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
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
idUUID or null
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.
createdOndatetime or null
The date this entity was created.
createdByUUID or null
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedByUUID or null
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.