Update a comment

PATCH/v1/comments/{id}

Partial update — only provided fields change. `resolved` resolves/reopens the thread (a field update, not a verb route). `metadata` merges (key→value sets, key→null deletes, {} clears all).

Requires an API key (bearer), scoped to the active org. Supports idempotency keys.

Path parameters

idstringrequired

Body parameters

bodystringoptionalmax 5000 chars
resolvedbooleanoptional
Resolve (true) or reopen (false).
metadataobjectoptional
Arbitrary key/value map; merge-on-write (§6).

Returns

200The updated comment.

Failures use the standard error envelope with a closed set of codes.

Terminal

renza comments update com_5d2a…

PATCH /v1/comments/{id}

curl https://api.renza.io/v1/comments/com_5d2a… \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{
  "resolved": true
}'

TypeScript

import { createRenzaClient } from "renza-sdk";

const renza = createRenzaClient({ apiKey: process.env.RENZA_API_KEY! });

const comment = await renza.comments.update("com_5d2a…", {
  resolved: true,
});

Response 200

{
  "id": "com_5d2a…",
  "object": "comment",
  "deck": "deck_2a9f…",
  "artifact": "art_7c1b…",
  "parent": null,
  "author": "usr_1a2b…",
  "slide_index": 2,
  "anchor": {
    "kind": "element",
    "ref": "h2#title",
    "refKind": "id",
    "x": 0.5,
    "y": 0.5
  },
  "body": "This number looks off — should it be Q3?",
  "resolved": false,
  "resolved_at": "2026-06-19T10:30:00.000Z",
  "resolved_by": null,
  "external_id": "review-note-1",
  "livemode": true,
  "metadata": {},
  "created_at": "2026-06-19T10:30:00.000Z",
  "updated_at": "2026-06-19T10:30:00.000Z"
}