Web API

Press shift + S to search API reference.

Comments

Create comment

posthttps://api.airtable.com/v0/{baseId}/{tableIdOrName}/{recordId}/comments

Creates a comment on a record. User mentioned is supported.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopedata.recordComments:write
User role

Base commenter

Billing plansAll plans

Path parameters

baseId
string
tableIdOrName
string
recordId
string

Request body

parentCommentId
optional<string>

A comment ID

text
string

Response format

id
string

A comment ID

createdTime
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

lastUpdatedTime
string | null

A date timestamp in the ISO format, eg: "2018-01-01T00:00:00.000Z", or null if this comment has not been updated since creation.

text
string

The comment text itself. Note that this can contain the user mentioned in the text. See user mentioned for more.

parentCommentId
optional<string>

The comment ID of the parent comment, if this comment is a threaded reply.

mentioned
optional<object>
key: stringUser mentioned
reactions
optional<array of the below object>

A list of reactions on this comment. Each entry contains information about the emoji itself, along with metadata about the user who reacted.

emoji
object
unicodeCharacter
string
reactingUser
object
userId
string

A user ID

email
string
name
optional<string>
author
object
id
string

A user ID

email
string
name
optional<string>
Request (example)
Copy
$
curl -X POST "https://api.airtable.com/v0/{baseId}/{tableIdOrName}/{recordId}/comments" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"text": "Hello, world!"
}'
200 – Response (example)
{
"author": {
"email": "foo@bar.com",
"id": "usrL2PNC5o3H4lBEi",
"name": "Foo Bar"
},
"createdTime": "2021-03-01T09:00:00.000Z",
"id": "comB5z37Mg9zaEPw6",
"lastUpdatedTime": null,
"text": "Hello, world!"
}
Request (example)
Copy
$
curl -X POST "https://api.airtable.com/v0/{baseId}/{tableIdOrName}/{recordId}/comments" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"parentCommentId": "comB5z37Mg9zaEPw6",
"text": "Hello from a threaded reply, @[usrL2PNC5o3H4lBEi]"
}'
200 – Response (example)
{
"author": {
"email": "foo@bam.com",
"id": "usrsOEchC9xuwRgKk",
"name": "Foo Baz"
},
"createdTime": "2021-03-01T10:00:00.000Z",
"id": "comeNPu0X9K4Rxzid",
"lastUpdatedTime": null,
"mentioned": {
"usrL2PNC5o3H4lBEi": {
"displayName": "Foo Bar",
"email": "foo@bar.com",
"id": "usrL2PNC5o3H4lBEi",
"type": "user"
}
},
"parentCommentId": "comB5z37Mg9zaEPw6",
"text": "Hello from a threaded reply, @[usrL2PNC5o3H4lBEi]"
}