Skip to main content
PATCH
/
grid-views
/
{id}
Update a saved grid view
curl --request PATCH \
  --url https://www.merchkit.com/api/v1/grid-views/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "entityType": "<string>",
  "visibleColumns": [
    "<string>"
  ],
  "pinnedLeft": [
    "<string>"
  ],
  "pinnedRight": [
    "<string>"
  ],
  "sorting": [
    {
      "colId": "<string>"
    }
  ],
  "filters": [
    {}
  ],
  "isDefault": true
}
'

Authorizations

​
Authorization
string
header
required

Workspace-scoped API key. Available scopes:

  • read:products: List and read products, assets, vendors, sources, and merch.
  • write:products: Create and update products and their attribute values.
  • delete:products: Delete products.
  • read:attributes: List and read attribute definitions.
  • write:attributes: Create, update, and delete attribute definitions.
  • write:attribute_values: Set attribute values on entities.
  • read:views: List and read saved grid views.
  • write:views: Create and update grid views.
  • read:vendors: List and read vendor records.
  • write:vendors: Create and update vendor records.
  • read:categories: List and read categories.
  • write:categories: Create and update categories.
  • read:channels: Read the available channel catalog.
  • read:completeness: Check per-channel completeness for entities.
  • read:history: Read entity history and the account change feed.
  • read:jobs: Poll asynchronous job status.
  • data:import: Start import operations.
  • data:export: Start export operations.

Path Parameters

​
id
string<uuid>
required

The resource UUID.

Body

application/json

Saved grid view (friendly shape; mapped to the stored view_config).

​
name
string
​
entityType
string
​
visibleColumns
string[]

Ordered visible attribute keys.

​
pinnedLeft
string[]
​
pinnedRight
string[]
​
sorting
object[]
​
filters
object[]
​
filterJoin
enum<string>
Available options:
AND,
OR
​
isDefault
boolean

Response

200

The updated grid view.