Update a layout

Authorization

apiKey

Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

id*string

The unique ID of the layout.

Query Parameters

silent?boolean

When true, suppresses in-app and Slack notifications for this mutation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

data*

The changes to apply.

Response Body

`application/json`

curl -X PATCH "https://example.com/workspaces/string/layouts/string" \  -H "Content-Type: application/json" \  -d '{    "data": {      "type": "layout",      "id": "list__person",      "attributes": {        "tree": {          "version": 1,          "children": [            {              "id": "views",              "type": "NavGroup",              "props": {                "name": "Views"              },              "children": [                {                  "id": "all-people",                  "type": "NavLink",                  "props": {                    "entity": "person"                  }                }              ]            }          ]        }      }    }  }'

{
  "_id": "list__person",
  "tree": {
    "version": 1,
    "children": [
      {
        "id": "views",
        "type": "NavGroup",
        "props": {
          "name": "Views"
        },
        "children": [
          {
            "id": "all-people",
            "type": "NavLink",
            "props": {
              "entity": "person"
            }
          }
        ]
      }
    ]
  },
  "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",
  "_updated_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",
  "_created_at": "2026-01-15T09:30:00.000Z",
  "_updated_at": "2026-02-01T17:45:00.000Z"
}