Tables

Rename a table or change its primary field

The id never changes, it is the column name and what every rule and page points at.

PATCH/v1/apps/{appId}/tables/{tableId}

Request

curl --request PATCH \
  --url 'https://studio.gtable.app/v1/apps/<appId>/tables/<tableId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "plural": "<string>",
  "primaryFieldId": "<string>"
}'

import json
import requests

url = "https://studio.gtable.app/v1/apps/<appId>/tables/<tableId>"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"name\":\"<string>\",\"plural\":\"<string>\",\"primaryFieldId\":\"<string>\"}")

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

const response = await fetch("https://studio.gtable.app/v1/apps/<appId>/tables/<tableId>", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>",
    "plural": "<string>",
    "primaryFieldId": "<string>"
  }),
});

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.gtable.app/v1/apps/<appId>/tables/<tableId>");
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>\",\"plural\":\"<string>\",\"primaryFieldId\":\"<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.gtable.app/v1/apps/<appId>/tables/<tableId>", bytes.NewBuffer([]byte("{\"name\":\"<string>\",\"plural\":\"<string>\",\"primaryFieldId\":\"<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.gtable.app/v1/apps/<appId>/tables/<tableId>"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"plural\":\"<string>\",\"primaryFieldId\":\"<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.gtable.app/v1/apps/<appId>/tables/<tableId>")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\",\"plural\":\"<string>\",\"primaryFieldId\":\"<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>",
    "plural": "<string>",
    "description": "<string>",
    "primaryFieldId": "<string>",
    "fields": [
      {}
    ]
  }
}

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

The name is what people read.

Requires the schema:write scope. Operation tables.update. MCP tool tables_update. CLI, once published: gtable tables update.

Path parameters

Name	Type	Required	Description
`appId`	string	yes
`tableId`	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 120 characters.
`plural`	string	no	Up to 120 characters.
`primaryFieldId`	string	no

Response

application/json

Success

dataobjectrequired

Show child attributes

idstringrequired

namestringrequired

pluralstring

descriptionstring

primaryFieldIdstringrequired

fieldsobject[]required

curl --request PATCH \ --url 'https://studio.gtable.app/v1/apps/<appId>/tables/<tableId>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "plural": "<string>", "primaryFieldId": "<string>" }'

Rename a table or change its primary field

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