Comments

Comment on a record

Leaves a note on a record.

POST/v1/tables/{tableId}/records/{recordId}/comments

Request

curl --request POST \
  --url 'https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "<string>"
}'

import json
import requests

url = "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"text\":\"<string>\"}")

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

const response = await fetch("https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "text": "<string>"
  }),
});

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"text\":\"<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("POST", "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments", bytes.NewBuffer([]byte("{\"text\":\"<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://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"text\":\"<string>\"}"))
    .build();

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

require 'net/http'
require 'json'

uri = URI("https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"text\":\"<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>",
    "tableId": "<string>",
    "recordId": "<string>",
    "authorId": "<string>",
    "text": "<string>",
    "mentions": [
      "<string>"
    ],
    "createdAt": "<string>",
    "editedAt": null
  }
}

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

mentions carries the user ids named with @ in the body; anyone in it who cannot see this record is dropped, because naming them would either leak that the record exists or send them to a refusal. Ask comments.mentionable for the list you may name.

Requires the records:write scope. Operation comments.create. MCP tool comments_create. CLI, once published: gtable comments create.

Path parameters

Name	Type	Required	Description
`tableId`	string	yes
`recordId`	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
`text`	string	yes	Up to 4000 characters.
`mentions`	string[]	no	Up to 20 items.

Response

application/json

Success

dataobjectrequired

Show child attributes

idstringrequired

tableIdstringrequired

recordIdstringrequired

authorIdstringrequired

textstringrequired

mentionsstring[]required

createdAtstringrequired

editedAtstringnullrequired

curl --request POST \ --url 'https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "text": "<string>" }'

{ "data": { "id": "<string>", "tableId": "<string>", "recordId": "<string>", "authorId": "<string>", "text": "<string>", "mentions": [ "<string>" ], "createdAt": "<string>", "editedAt": null } }

Comment on a record

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