Update

PATCH

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/comments/:commentId

PATCH

/v1/landscapes/:landscapeId/versions/:versionId/comments/:commentId

1 import { IcePanelClient } from "@icepanel/sdk";
2 
3 async function main() {
4     const client = new IcePanelClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.comments.update("landscapeId", "versionId", "commentId", {
8         body: {},
9     });
10 }
11 main();

Try it

200Updated

1 {
2   "comment": {
3     "body": {
4       "content": "string",
5       "showContentPreview": true,
6       "status": "open",
7       "type": "question"
8     },
9     "commit": 1.1,
10     "mentionedUserIds": [
11       "string"
12     ],
13     "handleId": "string",
14     "createdAt": "2024-01-15T09:30:00Z",
15     "createdBy": "user",
16     "createdById": "string",
17     "diagrams": {},
18     "id": "string",
19     "landscapeId": "string",
20     "replyCount": 1.1,
21     "updatedAt": "2024-01-15T09:30:00Z",
22     "updatedBy": "user",
23     "updatedById": "string",
24     "version": 1.1,
25     "versionId": "string",
26     "deletedAt": "2024-01-15T09:30:00Z",
27     "deletedBy": "user",
28     "deletedById": "string",
29     "latestEntityId": "string"
30   }
31 }

Authentication

X-API-Keystring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

landscapeIdstringRequired

versionIdstringRequired

commentIdstringRequired

Request

This endpoint expects an object.

bodyobjectOptional

commitdoubleOptional

mentionedUserIdslist of stringsOptional

Response

commentobject

Authentication

Path parameters

Request

Response

Errors