Update a View

JavaScript

import Moonbase from '@moonbaseai/sdk';

const client = new Moonbase({
  apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
});

const view = await client.views.update('id', {
  aggregates: [{ type: 'item_count', group: 'stage' }],
  fields: [
    { field: 'name', is_pinned: true },
    { field: 'amount' },
    { field: 'stage' },
    { field: 'owner', display_fields: ['name', 'email'] },
    { field: 'related_tasks' },
  ],
  filter: {
    field: 'name',
    op: 'eq',
    value: 'Acme',
  },
  groups: ['stage'],
  name: 'Active deals',
  relation_value_filters: [
    {
      field: 'related_tasks',
      filter: {
        field: 'state',
        op: 'eq',
        value: 'Open',
      },
    },
  ],
  sort: ['-name'],
});

console.log(view.id);

import os
from moonbase import Moonbase

client = Moonbase(
    api_key=os.environ.get("MOONBASE_API_KEY"),  # This is the default and can be omitted
)
view = client.views.update(
    id="id",
    aggregates=[{
        "type": "item_count",
        "group": "stage",
    }],
    fields=[{
        "field": "name",
        "is_pinned": True,
    }, {
        "field": "amount"
    }, {
        "field": "stage"
    }, {
        "field": "owner",
        "display_fields": ["name", "email"],
    }, {
        "field": "related_tasks"
    }],
    filter={
        "field": "name",
        "op": "eq",
        "value": "Acme",
    },
    groups=["stage"],
    name="Active deals",
    relation_value_filters=[{
        "field": "related_tasks",
        "filter": {
            "field": "state",
            "op": "eq",
            "value": "Open",
        },
    }],
    sort=["-name"],
)
print(view.id)

package main

import (
	"context"
	"fmt"

	"github.com/moonbaseai/moonbase-sdk-go"
	"github.com/moonbaseai/moonbase-sdk-go/option"
)

func main() {
	client := moonbase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	view, err := client.Views.Update(
		context.TODO(),
		"id",
		moonbase.ViewUpdateParams{
			Aggregates: []moonbase.ViewAggregateUnionParam{{
				OfItemCount: &moonbase.ViewAggregateItemCountParam{
					Group: moonbase.String("stage"),
				},
			}},
			Fields: []moonbase.ViewFieldParam{{
				Field:    "name",
				IsPinned: moonbase.Bool(true),
			}, {
				Field: "amount",
			}, {
				Field: "stage",
			}, {
				Field:         "owner",
				DisplayFields: []string{"name", "email"},
			}, {
				Field: "related_tasks",
			}},
			Filter: moonbase.ItemsFilterUnionParam{
				OfItemsFilterValueMatches: &moonbase.ItemsFilterValueMatchesParam{
					Field: "name",
					Op:    moonbase.ItemsFilterValueMatchesOpEq,
					Value: moonbase.ItemsFilterValueMatchesValueUnionParam{
						OfString: moonbase.String("Acme"),
					},
				},
			},
			Groups: []string{"stage"},
			Name:   moonbase.String("Active deals"),
			RelationValueFilters: []moonbase.ViewRelationValueFilterParam{{
				Field: "related_tasks",
				Filter: moonbase.ItemsFilterUnionParam{
					OfItemsFilterValueMatches: &moonbase.ItemsFilterValueMatchesParam{
						Field: "state",
						Op:    moonbase.ItemsFilterValueMatchesOpEq,
						Value: moonbase.ItemsFilterValueMatchesValueUnionParam{
							OfString: moonbase.String("Open"),
						},
					},
				},
			}},
			Sort: []string{"-name"},
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", view.ID)
}

curl --request PATCH \
  --url https://api.moonbase.ai/v0/views/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Active deals",
  "filter": {
    "field": "name",
    "op": "eq",
    "value": "Acme"
  },
  "sort": [
    "-name"
  ],
  "groups": [
    "stage"
  ],
  "aggregates": [
    {
      "type": "item_count",
      "group": "stage"
    }
  ],
  "fields": [
    {
      "field": "name",
      "is_pinned": true
    },
    {
      "field": "amount"
    },
    {
      "field": "stage"
    },
    {
      "field": "owner",
      "display_fields": [
        "name",
        "email"
      ]
    },
    {
      "field": "related_tasks"
    }
  ],
  "relation_value_filters": [
    {
      "field": "related_tasks",
      "filter": {
        "field": "state",
        "op": "eq",
        "value": "Open"
      }
    }
  ]
}
'

{
  "id": "1CLJt2uf2UnqHG2xD5kQvf",
  "type": "view",
  "relation_value_filters": [
    {
      "field": "related_tasks",
      "filter": {
        "op": "eq",
        "field": "state",
        "value": "1CLJt2uydBpGSuhiKAgXgr"
      }
    }
  ],
  "created_at": "2025-02-17T16:00:00.000Z",
  "updated_at": "2025-02-17T16:00:00.000Z",
  "view_type": "board",
  "name": "Active deals",
  "collection": {
    "id": "1CLJt2ue2wzMeQ5XRuS4TZ",
    "type": "collection",
    "ref": "deals"
  },
  "filter": {
    "op": "eq",
    "field": "name",
    "value": "Acme"
  },
  "sort": [
    "-name"
  ],
  "groups": [
    "stage"
  ],
  "aggregates": [
    {
      "type": "item_count",
      "group": "stage"
    }
  ],
  "fields": [
    {
      "field": "name",
      "is_pinned": true
    },
    {
      "field": "amount"
    },
    {
      "field": "stage"
    },
    {
      "field": "owner",
      "display_fields": [
        "name",
        "email"
      ]
    },
    {
      "field": "related_tasks"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "400",
      "title": "Bad Request",
      "detail": "The request could not be understood due to malformed syntax or invalid parameters."
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "401",
      "title": "Unauthorized",
      "detail": "Invalid or missing API key or JWT. You should provide your Moonbase API Key or JWT in the authorization header, in the format: \"Authorization: Bearer MOONBASE_API_KEY\""
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "403",
      "title": "Forbidden"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "404",
      "title": "Not Found"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "422",
      "title": "Unprocessable Entity",
      "detail": "Unknown field \"nonexistent\" for collections [\"deals\"].",
      "source": {
        "pointer": "/filter"
      }
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "429",
      "title": "Too Many Requests"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "500",
      "title": "Internal Server Error"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "503",
      "title": "Service Unavailable",
      "detail": "The service is temporarily unavailable, please try again later."
    }
  ]
}

PATCH

views

{id}

JavaScript

import Moonbase from '@moonbaseai/sdk';

const client = new Moonbase({
  apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
});

const view = await client.views.update('id', {
  aggregates: [{ type: 'item_count', group: 'stage' }],
  fields: [
    { field: 'name', is_pinned: true },
    { field: 'amount' },
    { field: 'stage' },
    { field: 'owner', display_fields: ['name', 'email'] },
    { field: 'related_tasks' },
  ],
  filter: {
    field: 'name',
    op: 'eq',
    value: 'Acme',
  },
  groups: ['stage'],
  name: 'Active deals',
  relation_value_filters: [
    {
      field: 'related_tasks',
      filter: {
        field: 'state',
        op: 'eq',
        value: 'Open',
      },
    },
  ],
  sort: ['-name'],
});

console.log(view.id);

import os
from moonbase import Moonbase

client = Moonbase(
    api_key=os.environ.get("MOONBASE_API_KEY"),  # This is the default and can be omitted
)
view = client.views.update(
    id="id",
    aggregates=[{
        "type": "item_count",
        "group": "stage",
    }],
    fields=[{
        "field": "name",
        "is_pinned": True,
    }, {
        "field": "amount"
    }, {
        "field": "stage"
    }, {
        "field": "owner",
        "display_fields": ["name", "email"],
    }, {
        "field": "related_tasks"
    }],
    filter={
        "field": "name",
        "op": "eq",
        "value": "Acme",
    },
    groups=["stage"],
    name="Active deals",
    relation_value_filters=[{
        "field": "related_tasks",
        "filter": {
            "field": "state",
            "op": "eq",
            "value": "Open",
        },
    }],
    sort=["-name"],
)
print(view.id)

package main

import (
	"context"
	"fmt"

	"github.com/moonbaseai/moonbase-sdk-go"
	"github.com/moonbaseai/moonbase-sdk-go/option"
)

func main() {
	client := moonbase.NewClient(
		option.WithAPIKey("My API Key"),
	)
	view, err := client.Views.Update(
		context.TODO(),
		"id",
		moonbase.ViewUpdateParams{
			Aggregates: []moonbase.ViewAggregateUnionParam{{
				OfItemCount: &moonbase.ViewAggregateItemCountParam{
					Group: moonbase.String("stage"),
				},
			}},
			Fields: []moonbase.ViewFieldParam{{
				Field:    "name",
				IsPinned: moonbase.Bool(true),
			}, {
				Field: "amount",
			}, {
				Field: "stage",
			}, {
				Field:         "owner",
				DisplayFields: []string{"name", "email"},
			}, {
				Field: "related_tasks",
			}},
			Filter: moonbase.ItemsFilterUnionParam{
				OfItemsFilterValueMatches: &moonbase.ItemsFilterValueMatchesParam{
					Field: "name",
					Op:    moonbase.ItemsFilterValueMatchesOpEq,
					Value: moonbase.ItemsFilterValueMatchesValueUnionParam{
						OfString: moonbase.String("Acme"),
					},
				},
			},
			Groups: []string{"stage"},
			Name:   moonbase.String("Active deals"),
			RelationValueFilters: []moonbase.ViewRelationValueFilterParam{{
				Field: "related_tasks",
				Filter: moonbase.ItemsFilterUnionParam{
					OfItemsFilterValueMatches: &moonbase.ItemsFilterValueMatchesParam{
						Field: "state",
						Op:    moonbase.ItemsFilterValueMatchesOpEq,
						Value: moonbase.ItemsFilterValueMatchesValueUnionParam{
							OfString: moonbase.String("Open"),
						},
					},
				},
			}},
			Sort: []string{"-name"},
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", view.ID)
}

curl --request PATCH \
  --url https://api.moonbase.ai/v0/views/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Active deals",
  "filter": {
    "field": "name",
    "op": "eq",
    "value": "Acme"
  },
  "sort": [
    "-name"
  ],
  "groups": [
    "stage"
  ],
  "aggregates": [
    {
      "type": "item_count",
      "group": "stage"
    }
  ],
  "fields": [
    {
      "field": "name",
      "is_pinned": true
    },
    {
      "field": "amount"
    },
    {
      "field": "stage"
    },
    {
      "field": "owner",
      "display_fields": [
        "name",
        "email"
      ]
    },
    {
      "field": "related_tasks"
    }
  ],
  "relation_value_filters": [
    {
      "field": "related_tasks",
      "filter": {
        "field": "state",
        "op": "eq",
        "value": "Open"
      }
    }
  ]
}
'

{
  "id": "1CLJt2uf2UnqHG2xD5kQvf",
  "type": "view",
  "relation_value_filters": [
    {
      "field": "related_tasks",
      "filter": {
        "op": "eq",
        "field": "state",
        "value": "1CLJt2uydBpGSuhiKAgXgr"
      }
    }
  ],
  "created_at": "2025-02-17T16:00:00.000Z",
  "updated_at": "2025-02-17T16:00:00.000Z",
  "view_type": "board",
  "name": "Active deals",
  "collection": {
    "id": "1CLJt2ue2wzMeQ5XRuS4TZ",
    "type": "collection",
    "ref": "deals"
  },
  "filter": {
    "op": "eq",
    "field": "name",
    "value": "Acme"
  },
  "sort": [
    "-name"
  ],
  "groups": [
    "stage"
  ],
  "aggregates": [
    {
      "type": "item_count",
      "group": "stage"
    }
  ],
  "fields": [
    {
      "field": "name",
      "is_pinned": true
    },
    {
      "field": "amount"
    },
    {
      "field": "stage"
    },
    {
      "field": "owner",
      "display_fields": [
        "name",
        "email"
      ]
    },
    {
      "field": "related_tasks"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "400",
      "title": "Bad Request",
      "detail": "The request could not be understood due to malformed syntax or invalid parameters."
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "401",
      "title": "Unauthorized",
      "detail": "Invalid or missing API key or JWT. You should provide your Moonbase API Key or JWT in the authorization header, in the format: \"Authorization: Bearer MOONBASE_API_KEY\""
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "403",
      "title": "Forbidden"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "404",
      "title": "Not Found"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "422",
      "title": "Unprocessable Entity",
      "detail": "Unknown field \"nonexistent\" for collections [\"deals\"].",
      "source": {
        "pointer": "/filter"
      }
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "429",
      "title": "Too Many Requests"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "500",
      "title": "Internal Server Error"
    }
  ]
}

{
  "type": "errors",
  "errors": [
    {
      "type": "error",
      "status": "503",
      "title": "Service Unavailable",
      "detail": "The service is temporarily unavailable, please try again later."
    }
  ]
}

Authorizations

Authorization

string

header

required

Your Moonbase API key.

Path Parameters

string

required

The ID of the view to update.

Body

application/json

The View values to update.

Parameters for updating a view. Omitted values are left unchanged.

name

string

The name of the view.

Maximum string length: 255

view_type

enum<string>

The type of view, table or board.

Available options:

table,

board

filter

Match Value · object

The filter applied to the view's items, or null to clear it.

Match Value
Value Exists
AND
OR
NOT

Show child attributes

sort

string[]

Sort items returned by the specified fields. An empty array clears the sort.

groups

string[]

Fields whose values group the view's items. An empty array clears the grouping.

Maximum array length: 1

Identifies a field directly (name) or through relations (organization.name, deals.owner.email). Every segment before the last is a relation field; the last is the field you want. Keys preferred; use ids to disambiguate where there are multiple allowed collections.

aggregates

(Item Count · object | Field Statistic · object)[]

The metrics computed over the view's items. An empty array clears them.

Counts the view's items.

Item Count
Field Statistic

Show child attributes

fields

ViewField · object[]

The view's columns, in display order. If provided, it must contain at least one column.

Minimum array length: 1

Show child attributes

relation_value_filters

ViewRelationValueFilter · object[]

Filters limiting which related items the view's relation columns show. An empty array clears them.

Show child attributes

Response

Update succeeded.

A View represents a saved configuration for displaying items in a collection, including filters and sorting rules.

type

string

required

String representing the object’s type. Always view for this object.

Allowed value: "view"

string

required

Unique identifier for the object.

view_type

enum<string>

required

The type of view, such as table or board.

Available options:

table,

board

name

string

required

The name of the view.

collection

CollectionPointer · object

required

The Collection this view belongs to.

Show child attributes

filter

Match Value · object

required

The filter applied to the view's items, or null when the view has no filter.

Match Value
Value Exists
AND
OR
NOT

Show child attributes

sort

string[]

required

Sort items returned by the specified fields. Empty when the view has no sort.

groups

string[]

required

Fields whose values group the view's items. Empty when the view is not grouped.

Maximum array length: 1

aggregates

(Item Count · object | Field Statistic · object)[]

required

The metrics computed over the view's items.

Counts the view's items.

Item Count
Field Statistic

Show child attributes

fields

ViewField · object[]

required

The view's columns, in display order.

Minimum array length: 1

Show child attributes

relation_value_filters

ViewRelationValueFilter · object[]

required

Filters limiting which related items the view's relation columns show.

Show child attributes

created_at

string<date-time>

required

Time at which the object was created, as an ISO 8601 timestamp in UTC.

updated_at

string<date-time>

required

Time at which the object was last updated, as an ISO 8601 timestamp in UTC.

⌘I

Introduction

Core Concepts

API Reference

Authorizations

Path Parameters

Body

Response