CRcraft
Views

PATCH /workspace/{workspaceId}/views/{viewId}

Changed on

Change a view's filters, controllers, name or category.

Request

  • Base URL
    https://api.craft.io
  • URL
    https://api.craft.io/workspace/{workspaceId}/views/{viewId}
  • Auth
    API key in header x-api-key

Path parameters

workspaceIdstring required
viewIdstring required

Request body

namestring
categorystring
replaceAllFiltersboolean
columnsstring[]

Ordered visible columns — table and okr-table only. Replaces the current set outright; there is no per-column merge.

Supported because the app changes columns on an existing view through the same call. Without it an agent asked to add one column had to recreate the whole view, which left the original behind as a duplicate.

layoutstring[]

Card fields — kanban, timeline and swimlanes only. Replaces the current set.

columnColorsobject

Per-column colours as #RRGGBB, keyed like columns. Send {} to clear. Duplicating a view: pass what get_view returned, or the copy loses them.

compactModestring

Card density, kanban / timeline / swimlanes only: compact or default.

Response

The updated view

viewIdstring required
namestring required
viewTypestring required
ownerType'personal' | 'workspace' required
categorystring
workspaceIdstring
portfolioIdstring
webUrlstring
columnsstring[]
layoutstring[]
compactModestring

Card density on a card-based view: compact or default.

filtersRecordStringUnknown required

Construct a type with a set of properties K of type T

listItemsParamsRecordStringString required

Construct a type with a set of properties K of type T

listItemsTool'list_items' | 'list_portfolio_items' | 'list_feedback_items' required

Which list tool listItemsParams belongs to. Feedback views are the reason this is stated rather than assumed — their items are not work items.

columnColorsRecordStringString

Construct a type with a set of properties K of type T

Changes

  • 2972a1b05ab1Revision changes
    • info

      added the optional property to the response with the status

  • 10d02d3ad149Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status