Rename a page, change its mode, or change who sees it

Any of name, mode, tableId and visibleTo.

PATCH/v1/apps/{appId}/pages/{pageId}

Request

curl --request PATCH \
  --url 'https://studio.grid82.app/v1/apps/<appId>/pages/<pageId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "kind": "declarative",
  "mode": "locked",
  "tableId": "<string>",
  "visibleTo": "<string>"
}'

import json
import requests

url = "https://studio.grid82.app/v1/apps/<appId>/pages/<pageId>"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"name\":\"<string>\",\"kind\":\"declarative\",\"mode\":\"locked\",\"tableId\":\"<string>\",\"visibleTo\":\"<string>\"}")

response = requests.request("PATCH", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/apps/<appId>/pages/<pageId>", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>",
    "kind": "declarative",
    "mode": "locked",
    "tableId": "<string>",
    "visibleTo": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/apps/<appId>/pages/<pageId>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"name\":\"<string>\",\"kind\":\"declarative\",\"mode\":\"locked\",\"tableId\":\"<string>\",\"visibleTo\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("PATCH", "https://studio.grid82.app/v1/apps/<appId>/pages/<pageId>", bytes.NewBuffer([]byte("{\"name\":\"<string>\",\"kind\":\"declarative\",\"mode\":\"locked\",\"tableId\":\"<string>\",\"visibleTo\":\"<string>\"}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/apps/<appId>/pages/<pageId>"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"kind\":\"declarative\",\"mode\":\"locked\",\"tableId\":\"<string>\",\"visibleTo\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/apps/<appId>/pages/<pageId>")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\",\"kind\":\"declarative\",\"mode\":\"locked\",\"tableId\":\"<string>\",\"visibleTo\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "kind": "declarative",
    "mode": "locked",
    "owner": "admin",
    "ownerUserId": "<string>",
    "tableId": "<string>",
    "forkedFrom": "<string>",
    "visibleTo": "*",
    "reads": {
      "tables": [],
      "fields": [],
      "views": []
    },
    "bundleHash": "<string>",
    "publishedVersion": 123,
    "theme": {
      "accent": "<string>",
      "radius": 123.45
    },
    "document": null,
    "version": 1,
    "updatedAt": "<string>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

A page has one mode for everyone: it cannot be locked for one role and a Template for another.

Requires the pages:write scope. Operation pages.update. MCP tool pages_update. CLI: grid82 pages update (npx grid82).

Path parameters

Name	Type	Required	Description
`appId`	string	yes
`pageId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`name`	string	no	Up to 60 characters.
`kind`	“declarative” or “code”	no
`mode`	“locked” or “template”	no
`tableId`	string	no	Up to 64 characters.
`visibleTo`	”*” or string[]	no

Response

application/json

Success

dataobjectrequired

Show child attributes

data.idstringrequiredlength: 1–64 chars

data.namestringrequiredlength: 1–120 chars

data.kindenum<string>requiredone of: declarative, code

data.modeenum<string>requiredone of: locked, template, canvas

data.ownerenum<string>requiredone of: admin, user

data.ownerUserIdstringlength: ≤ 64 chars

data.tableIdstringpattern: ^[a-z][a-z0-9_]{0,62}$

data.forkedFromstringlength: ≤ 64 chars

data.visibleTostring | string[]requireddefault: *

data.readsobject

Show child attributes

data.reads.tablesstring[]requireddefault: []

data.reads.fieldsstring[]requireddefault: []

data.reads.viewsstring[]requireddefault: []

data.bundleHashstringlength: ≤ 128 chars

data.publishedVersionintegerrange: ≥ 1

data.themeobject

Show child attributes

data.theme.accentstringpattern: ^(?:#[0-9a-fA-F]{3,8}|oklch$[0-9.%\s/]{1,60}$)$

data.theme.radiusnumberrange: 0–24

data.documentobject

data.versionintegerrequireddefault: 1range: ≥ 1

data.updatedAtstringrequired

curl --request PATCH \ --url 'https://studio.grid82.app/v1/apps/<appId>/pages/<pageId>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "kind": "declarative", "mode": "locked", "tableId": "<string>", "visibleTo": "<string>" }'

{ "data": { "id": "<string>", "name": "<string>", "kind": "declarative", "mode": "locked", "owner": "admin", "ownerUserId": "<string>", "tableId": "<string>", "forkedFrom": "<string>", "visibleTo": "*", "reads": { "tables": [], "fields": [], "views": [] }, "bundleHash": "<string>", "publishedVersion": 123, "theme": { "accent": "<string>", "radius": 123.45 }, "document": null, "version": 1, "updatedAt": "<string>" } }

Rename a page, change its mode, or change who sees it

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown