Comment on a record
Adds a comment to the record, attributed to the calling user's synced profile. Requires the `records:comment` permission on the database, and rejects an empty body or one longer than 2,000 characters.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/databases/string/records/string/comments" \ -H "Content-Type: application/json" \ -d '{ "body": "string" }'{ "data": { "id": "string", "workspaceId": "string", "databaseId": "string", "recordId": "string", "authorUserId": "string", "authorDisplayName": "string", "authorAvatarUrl": "string", "body": "string", "createdAt": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}List the comments on a record
Returns the record's comments with each author's display name and avatar. Requires the `records:read` permission on the database.
Delete a comment on a record
Removes one comment from the record. An author may always delete their own comment; deleting someone else's additionally requires the `records:write` permission. Responds with not-found for a comment that is not on this record.