API v1 ReferenceCustom Fields

Updates an existing custom field definition with the specified id.

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.

Headers

AuthorizationstringRequired

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

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

OK

idUUIDOptional

The id of the custom field definition.

namestring or nullOptional

The name of the custom field definition.

entityenumOptional

The entity the custom field definition can be linked to.

Allowed values:
typeenumOptional

The type of the custom field definition.

createdOndatetimeOptional

The date this entity was created.

createdByUUIDOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedByUUIDOptional

The id of the user who last modified this entity.