Add comment

Add a plain-text comment to a record, up to 5,000 characters, optionally mentioning members. Nobody is notified by email.

POST/v1/w/{workspace}/records/{recordId}/comments

Send an Idempotency-Key. This may answer 202 while it waits for approval.

Path parameters

workspacestringrequired

Your workspace’s address name.

recordIdstringrequired

The record to comment on.

Headers

Idempotency-Keystring

8–100 characters. Repeat the same key and body to get the first outcome back instead of writing twice.

Body

bodystringrequired

The comment, 1 to 5,000 characters.

mentionsstring[]

Member identities to mention, from List members. At most 20.

Response

commentobjectrequired

untrustedstring[]

Details

Add plain text to a visible row (1–5,000 characters). Mention at most 20 workspace member identities. Guests cannot write. No notifications are sent. Never retry an uncertain write. Agents cannot edit or delete comments.

Since 2026-12. Errors are listed in Errors.

cURL

curl -X POST "https://api.olamma.sh/v1/w/your-workspace/records/{recordId}/comments" \
  -H "Authorization: Bearer $OLAMMA_KEY" \
  -H "Idempotency-Key: <unique key>" \
  -H "content-type: application/json" \
  -d '{
    "body": "Paid by bank transfer on 3 December."
  }'

Response 201

{
  "comment": {
    "id": "<string>",
    "author": "<string>",
    "body": "<string>",
    "createdAt": "2026-12-01T09:30:00Z"
  },
  "untrusted": [
    "<string>"
  ]
}