Rename an app, change its path, or its icon, theme and surfaces

Update the app's name, Studio icon (a name from the table icon library, or null for the default), appearance (accent, radius, font, density), slug, and enabled surfaces: data grid, interface, assistant, API, MCP, and CLI.

PATCH/v1/apps/{appId}

Request

curl --request PATCH \
  --url 'https://studio.grid82.app/v1/apps/<appId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "slug": "<string>",
  "icon": "<string>",
  "theme": {
    "radius": 6,
    "accent": "oklch(0.47 0.16 262)",
    "font": "inter",
    "icon": "<string>"
  },
  "surfaces": {
    "data": true,
    "interface": true,
    "assistant": true,
    "api": true,
    "mcp": true,
    "cli": true
  }
}'

import json
import requests

url = "https://studio.grid82.app/v1/apps/<appId>"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"name\":\"<string>\",\"slug\":\"<string>\",\"icon\":\"<string>\",\"theme\":{\"radius\":6,\"accent\":\"oklch(0.47 0.16 262)\",\"font\":\"inter\",\"icon\":\"<string>\"},\"surfaces\":{\"data\":true,\"interface\":true,\"assistant\":true,\"api\":true,\"mcp\":true,\"cli\":true}}")

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

const response = await fetch("https://studio.grid82.app/v1/apps/<appId>", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>",
    "slug": "<string>",
    "icon": "<string>",
    "theme": {
      "radius": 6,
      "accent": "oklch(0.47 0.16 262)",
      "font": "inter",
      "icon": "<string>"
    },
    "surfaces": {
      "data": true,
      "interface": true,
      "assistant": true,
      "api": true,
      "mcp": true,
      "cli": true
    }
  }),
});

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/apps/<appId>");
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>\",\"slug\":\"<string>\",\"icon\":\"<string>\",\"theme\":{\"radius\":6,\"accent\":\"oklch(0.47 0.16 262)\",\"font\":\"inter\",\"icon\":\"<string>\"},\"surfaces\":{\"data\":true,\"interface\":true,\"assistant\":true,\"api\":true,\"mcp\":true,\"cli\":true}}");
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>", bytes.NewBuffer([]byte("{\"name\":\"<string>\",\"slug\":\"<string>\",\"icon\":\"<string>\",\"theme\":{\"radius\":6,\"accent\":\"oklch(0.47 0.16 262)\",\"font\":\"inter\",\"icon\":\"<string>\"},\"surfaces\":{\"data\":true,\"interface\":true,\"assistant\":true,\"api\":true,\"mcp\":true,\"cli\":true}}")))
  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>"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"slug\":\"<string>\",\"icon\":\"<string>\",\"theme\":{\"radius\":6,\"accent\":\"oklch(0.47 0.16 262)\",\"font\":\"inter\",\"icon\":\"<string>\"},\"surfaces\":{\"data\":true,\"interface\":true,\"assistant\":true,\"api\":true,\"mcp\":true,\"cli\":true}}"))
    .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>")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\",\"slug\":\"<string>\",\"icon\":\"<string>\",\"theme\":{\"radius\":6,\"accent\":\"oklch(0.47 0.16 262)\",\"font\":\"inter\",\"icon\":\"<string>\"},\"surfaces\":{\"data\":true,\"interface\":true,\"assistant\":true,\"api\":true,\"mcp\":true,\"cli\":true}}"

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": {
    "schemaVersion": 123.45,
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "tables": [
      {
        "id": "<string>",
        "name": "<string>",
        "plural": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "primaryFieldId": "<string>",
        "fields": [
          {
            "id": "<string>",
            "name": "<string>",
            "width": 123,
            "type": "<string>",
            "config": {}
          }
        ]
      }
    ],
    "views": {},
    "rules": {
      "version": 123.45,
      "roles": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "assistantMonthlyCredits": 123,
          "interface": "assigned",
          "automations": "none"
        }
      ],
      "permissions": [
        {
          "role": "<string>",
          "tables": "<string>"
        }
      ]
    },
    "pages": [],
    "members": [],
    "theme": {
      "radius": 6,
      "accent": "oklch(0.47 0.16 262)",
      "font": "inter"
    },
    "surfaces": {
      "data": true,
      "interface": true,
      "assistant": true,
      "api": true,
      "mcp": true,
      "cli": true
    },
    "updatedAt": "<string>"
  }
}

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

Move slug to another path under the suite’s address, such as /crm to /sales; links and bookmarks to the old path stop working, and people must sign in again at the new path. Refuses a slug held by another app in the suite, including a deleted app, or a word the suite owns, such as login. Within a minute of disabling a surface, api refuses all calls using a key or connected token, including CLI calls; the app’s own screens continue working in a signed-in session. mcp refuses the app’s MCP endpoints and removes it from the suite’s MCP server. cli refuses the official command-line tool by its user agent; with API enabled, this stops the tool and nothing else. assistant removes the in-app assistant; data and interface hide their respective tabs. Disabling any surface deletes nothing.

Requires the schema:write scope. Operation apps.update. MCP tool apps_update. CLI: grid82 apps update (npx grid82).

Path parameters

Name	Type	Required	Description
`appId`	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 50 characters.
`slug`	string	no
`icon`	string or null	no
`theme`	object	no
`surfaces`	object	no

Response

application/json

Success

dataobjectrequired

Show child attributes

data.schemaVersionnumberrequired

data.idstringrequiredlength: 1–64 chars

data.namestringrequiredlength: 1–120 chars

data.slugstringrequiredpattern: ^[a-z0-9][a-z0-9-]{1,62}$

data.tablesobject[]requireditems: ≤ 200 items

Show child attributes

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

data.tables.namestringrequiredlength: 1–120 chars

data.tables.pluralstringlength: 1–120 chars

data.tables.descriptionstringlength: ≤ 2000 chars

data.tables.iconstring | null

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

data.tables.fieldsobject[]requireditems: 1–200 items

Show child attributes

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

data.tables.fields.namestringrequiredlength: 1–120 chars

data.tables.fields.widthintegerrange: 60–900

data.tables.fields.typestringrequired

data.tables.fields.configobjectrequireddefault: {}

data.viewsRecord<string, object[]>requireddefault: {}

data.rulesobjectrequired

Show child attributes

data.rules.versionnumberrequired

data.rules.rolesobject[]requireditems: 1–100 items

Show child attributes

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

data.rules.roles.namestringrequiredlength: 1–120 chars

data.rules.roles.descriptionstringlength: ≤ 500 chars

data.rules.roles.assistantMonthlyCreditsintegerrange: 0–10000000

data.rules.roles.interfaceenum<string>one of: assigned, own

data.rules.roles.automationsenum<string>one of: none, own

data.rules.permissionsobject[]requireditems: ≤ 100 items

Show child attributes

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

data.rules.permissions.tablesstring | Record<string, object>required

data.pagesobject[]requireddefault: []

Show child attributes

data.pages.idstringrequiredlength: 1–64 chars

data.pages.namestringrequiredlength: 1–120 chars

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

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

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

data.pages.ownerUserIdstringlength: ≤ 64 chars

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

data.pages.forkedFromstringlength: ≤ 64 chars

data.pages.visibleTostring | string[]requireddefault: *

data.pages.readsobject

Show child attributes

data.pages.reads.tablesstring[]requireddefault: []

data.pages.reads.fieldsstring[]requireddefault: []

data.pages.reads.viewsstring[]requireddefault: []

data.pages.bundleHashstringlength: ≤ 128 chars

data.pages.publishedVersionintegerrange: ≥ 1

data.pages.themeobject

Show child attributes

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

data.pages.theme.radiusnumberrange: 0–24

data.pages.documentobject

data.pages.versionintegerrequireddefault: 1range: ≥ 1

data.pages.updatedAtstringrequired

data.membersobject[]requireddefault: []

Show child attributes

data.members.userIdstringrequiredlength: 1–64 chars

data.members.emailstring<email>requiredpattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

data.members.namestringlength: ≤ 120 chars

data.members.rolesstring[]requireditems: ≥ 1 items

data.members.statusenum<string>requireddefault: invitedone of: invited, active, suspended

data.members.invitedAtstring

data.themeobjectrequireddefault: {"radius":6,"accent":"oklch(0.47 0.16 262)","font":"inter"}

Show child attributes

data.theme.radiusnumberrequireddefault: 6range: 0–24

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

data.theme.fontenum<string>requireddefault: interone of: system, geist, inter, figtree, manrope, jakarta, dm-sans, outfit, work-sans, nunito-sans, rubik, public-sans, source-serif, lora, fraunces, instrument-serif, geist-mono, jetbrains-mono, ibm-plex-mono

data.theme.iconstring | nulldefault: null

data.surfacesobjectrequireddefault: {"data":true,"interface":true,"assistant":true,"api":true,"mcp":true,"cli":true}

Show child attributes

data.surfaces.databooleanrequireddefault: true

data.surfaces.interfacebooleanrequireddefault: true

data.surfaces.assistantbooleanrequireddefault: true

data.surfaces.apibooleanrequireddefault: true

data.surfaces.mcpbooleanrequireddefault: true

data.surfaces.clibooleanrequireddefault: true

data.updatedAtstringrequired

curl --request PATCH \ --url 'https://studio.grid82.app/v1/apps/<appId>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "slug": "<string>", "icon": "<string>", "theme": { "radius": 6, "accent": "oklch(0.47 0.16 262)", "font": "inter", "icon": "<string>" }, "surfaces": { "data": true, "interface": true, "assistant": true, "api": true, "mcp": true, "cli": true } }'

{ "data": { "schemaVersion": 123.45, "id": "<string>", "name": "<string>", "slug": "<string>", "tables": [ { "id": "<string>", "name": "<string>", "plural": "<string>", "description": "<string>", "icon": "<string>", "primaryFieldId": "<string>", "fields": [ { "id": "<string>", "name": "<string>", "width": 123, "type": "<string>", "config": {} } ] } ], "views": {}, "rules": { "version": 123.45, "roles": [ { "id": "<string>", "name": "<string>", "description": "<string>", "assistantMonthlyCredits": 123, "interface": "assigned", "automations": "none" } ], "permissions": [ { "role": "<string>", "tables": "<string>" } ] }, "pages": [], "members": [], "theme": { "radius": 6, "accent": "oklch(0.47 0.16 262)", "font": "inter" }, "surfaces": { "data": true, "interface": true, "assistant": true, "api": true, "mcp": true, "cli": true }, "updatedAt": "<string>" } }

Rename an app, change its path, or its icon, theme and surfaces

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