Skip to content
Micro micro
Go to Micro
API Reference
Views

Update a view bundle (select/filter/sort arrays are replaced wholesale when supplied)

client.views.update(stringviewID, ViewUpdateParams { teamId, viewObjectType, aggregation_prop_def_id, 18 more } params, RequestOptionsoptions?): ViewUpdateResponse { name, view_type, id, 18 more }
PATCH/v2/prism/{teamId}/{viewObjectType}/views/{viewId}

Update a view bundle (select/filter/sort arrays are replaced wholesale when supplied)

ParametersExpand Collapse
viewID: string
formatuuid
params: ViewUpdateParams { teamId, viewObjectType, aggregation_prop_def_id, 18 more }
teamId?: string

Path param

formatuuid
viewObjectType: "action" | "deal" | "document" | 3 more

Path param

One of the following:
"action"
"deal"
"document"
"event"
"identity"
"organization"
aggregation_prop_def_id?: string | null

Body param

formatuuid
aggregation_type?: string | null

Body param

column_layout?: Record<string, unknown> | null

Body param

combinator?: "AND" | "OR"

Body param

One of the following:
"AND"
"OR"
filter?: Array<Record<string, unknown>>

Body param

group_by?: string | null

Body param

group_hidden_option_ids?: Array<unknown> | unknown | null

Body param

One of the following:
Array<unknown>
unknown
group_hide_empty?: boolean | null

Body param

group_sort?: string | null

Body param

icon?: string | null

Body param

list_id?: string | null

Body param

formatuuid
name?: string

Body param

select?: Array<string>

Body param

sort?: Array<Record<string, unknown>>

Body param

sort_order?: number | null

Body param

team_id?: string | null

Body param

formatuuid
user_id?: string | null

Body param

view_type?: string

Body param

idempotencyKey?: string

Header param: A unique key (UUID or any opaque string up to 255 chars) that identifies this logical request. The server caches the first response under this key for 24 hours and replays it on retry — safe to use on every POST/PUT/PATCH to make network retries deterministic. Reusing the same key with a different body returns 409 idempotency_key_mismatch. Replays include the idempotent-replay: true response header.

minLength1
maxLength255
ReturnsExpand Collapse
ViewUpdateResponse { name, view_type, id, 18 more }

A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.

name: string
view_type: string
id?: string
formatuuid
aggregation_prop_def_id?: string | null
formatuuid
aggregation_type?: string | null
column_layout?: Record<string, unknown> | null
combinator?: "AND" | "OR"
One of the following:
"AND"
"OR"
created_at?: string
filter?: Array<Record<string, unknown>>

Each entry is { slug: { comparator: value } }

group_by?: string | null

Property slug to group by

group_hidden_option_ids?: Array<unknown> | unknown | null
One of the following:
Array<unknown>
unknown
group_hide_empty?: boolean | null
group_sort?: string | null
icon?: string | null
list_id?: string | null
formatuuid
select?: Array<string>

Property slugs (dot-paths permitted for refs)

sort?: Array<Record<string, unknown>>

Each entry is { slug: ‘asc’ | ‘desc’ }

sort_order?: number | null
team_id?: string | null
formatuuid
updated_at?: string | null
user_id?: string | null

Update a view bundle (select/filter/sort arrays are replaced wholesale when supplied)

import Micro from '@micro-so/sdk';

const client = new Micro({
  teamID: 'My Team ID',
  apiKey: process.env['MICRO_API_KEY'], // This is the default and can be omitted
});

const view = await client.views.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  viewObjectType: 'action',
});

console.log(view.id);
{
  "name": "name",
  "view_type": "view_type",
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "aggregation_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "aggregation_type": "aggregation_type",
  "column_layout": {
    "foo": "bar"
  },
  "combinator": "AND",
  "created_at": "created_at",
  "filter": [
    {
      "foo": "bar"
    }
  ],
  "group_by": "group_by",
  "group_hidden_option_ids": [
    {}
  ],
  "group_hide_empty": true,
  "group_sort": "group_sort",
  "icon": "icon",
  "list_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "select": [
    "string"
  ],
  "sort": [
    {
      "foo": "bar"
    }
  ],
  "sort_order": 0,
  "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "updated_at",
  "user_id": "user_id"
}
Returns Examples
{
  "name": "name",
  "view_type": "view_type",
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "aggregation_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "aggregation_type": "aggregation_type",
  "column_layout": {
    "foo": "bar"
  },
  "combinator": "AND",
  "created_at": "created_at",
  "filter": [
    {
      "foo": "bar"
    }
  ],
  "group_by": "group_by",
  "group_hidden_option_ids": [
    {}
  ],
  "group_hide_empty": true,
  "group_sort": "group_sort",
  "icon": "icon",
  "list_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "select": [
    "string"
  ],
  "sort": [
    {
      "foo": "bar"
    }
  ],
  "sort_order": 0,
  "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "updated_at",
  "user_id": "user_id"
}