API v1 ReferenceCustom Fields

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

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

Path parameters

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

Request

The model describing the updated selection option.
valuestringRequired1-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
valuestring>=1 character
The selection value which can be later used in a select custom field.
idstringformat: "uuid"
The id of the custom field selection option.
colorenum or null
The color of the selection option.
orderdouble
The order of the custom field selection option.

Errors

404
Not Found Error