Update Custom Field

Update Custom Field allows you to modify a Custom Field definition in your Shortcut Workspace.

patch/api/v4/{workspace-slug}/custom-fields/{custom-field-public-id}

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/custom-fields/{custom-field-public-id}
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

custom-field-public-idstring uuid required

The unique ID of the Custom Field.

Query parameters

fieldsstring

Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.

Request body

after_idstring uuid

Move this Custom Field to after the field with this ID.

before_idstring uuid

Move this Custom Field to before the field with this ID.

descriptionstring

A description of the Custom Field.

enabledboolean

Whether the Custom Field is enabled.

icon_set_identifierstring

An identifier for the icon set for this Custom Field.

namestring

The name of the Custom Field.

values_removestring[]

IDs of enum values to remove from the Custom Field.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

Changes

No recorded changes to this operation across all 1 revision of this API.