---
title: "Comment on a record"
description: "Leaves a note on a record."
canonical: "https://gtable.app/docs/app-api/comments/create"
updated: "2026-10-05"
---

# Comment on a record

`POST https://your-suite.gtable.app/your-app/v1/tables/{tableId}/records/{recordId}/comments`

Leaves a note on a record.

> **Note: Generic contract**
>
> Your own version of this operation, with your tables and the fields you can read, is in
> your app's document: `https://{suite}.gtable.app/{app}/v1/openapi.json`, behind your credential.
> [Why each person gets their own](/docs/start/studio-and-runtime#why-an-app-has-an-api-of-its-own).

`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.        |