Skip to main content
PATCH
Error

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required
viewId
string
required

Body

application/json
columns
object[] | null

Table columns, in order. Replaces every column; [] leaves the view on the default columns. Stored as state.columns. null clears them too.

filters
object | null

Conditions every item the view shows must meet, joined by operator; a group node joins its own nodes with its own operator. Each leaf's type is the FIELD'S DATA TYPE (tag, stage, verificationResult, text, richText, number, date, toggle, user, presence) with fieldId a field key from the categories endpoint (or <typeId>::<key>), or a structural condition (type, linkedTo, timestamp, changedInBranch, the comment conditions). Tag, stage and verification values are option NAMES; user values are user ids; type ids are data type ids. Unknown fields, options, types or operations answer 400 and nothing is saved. Example — Status is Triage: {"operator":"and","nodes":[{"type":"tag","fieldId":"status","operation":"overlaps","tags":["Triage"]}]}. Stored as state.filters. null clears them.

icon
object | null

null removes the icon.

name
string
relationships
object[]

Nesting rules, in order: under each parentType, show items of childType. Replaces every rule; send [] to remove them all. Stored as state.relationships.

rootType
object | null

Data type id of the items the view starts from (its "Start type"). Stored as state.rootType. null clears it.

sort
object[] | null

Ordered sort keys, the first most significant. Replaces the whole sort; send [] for the natural order. Stored as state.sort. null clears it.

Response

200 - application/json
id
string
required
name
string
required
icon
object
position
number

Display order among the shared views.

state
object

The view configuration: rootType, relationships, columns, filters and sort as written here, plus display options edited in Flow.