Update a view

PATCH

/projects/:projectId/data-objects/:objectId/views/:viewId

Updates a view’s name/fields/filters/sorts. The default view cannot be renamed (400). Validates the view body against the definition (422). Requires data-view:manage on the project.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired

objectIdstringRequired

viewIdstringRequired

Request

This endpoint expects an object.

namestringOptional1-200 characters

fieldslist of objectsOptional

filterslist of objectsOptional

sortslist of objectsOptional

filterLogicstringOptional>=1 character

Response

The updated view.

viewobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

1	curl -X PATCH https:/https://api/projects/projectId/data-objects/objectId/views/viewId \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"view": {
3	"_id": "64b8f9e2a1c4d23f9b7e8a12",
4	"projectId": "proj_9f8e7d6c5b4a3210",
5	"objectDefinitionId": "obj_1234567890abcdef",
6	"name": "Active Users View",
7	"type": "table",
8	"isDefault": true,
9	"filterLogic": "(1 AND 2) OR 3",
10	"fields": [
11	{}
12	],
13	"filters": [
14	{}
15	],
16	"sorts": [
17	{}
18	],
19	"createdAt": "2024-06-10T09:15:00Z",
20	"updatedAt": "2024-06-15T16:45:00Z",
21	"createdBy": "user_7a8b9c0d1e2f3g4h"
22	}
23	}