Skip to main content
PATCH
Update a record view

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id
string
required

Project id (UUID) belonging to the caller workspace.

id
string
required

Record view id.

Body

application/json

Supplied fields are merged over the stored view and the whole result is re-validated, so a partial body is fine but a supplied field must be complete and valid. webhook_id cannot be changed.

name
string
Required string length: 1 - 80
columns
(string | object)[]
Required array length: 1 - 40 elements
Maximum string length: 128
sort_key
string | null
sort_dir
enum<string>
Available options:
asc,
desc
is_default
boolean

true clears the default flag on the webhook other views in the same batch.

portal_shared
boolean

Share this view with the project's portal customer (#376, read-only). A project is one customer's space with one portal, so this is a flag: the customer sees this view's columns over the project's rows of the dataset, provided the portal exposes it. Default false (private).

Response

Updated. The echoed view uses the same snake_case keys as the list.

view
object
required