v56

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014121451.1 MB

Comments

Update a comment

Update a comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.

put/v1/comments/{commentId}

Path parameters

commentIdstring required

Example:cmt_abc123def456

Unique comment identifier

Request body

contentstring required

Updated content of the comment

contextUrlstring

Optional URL of the page where the comment was updated, used for deep-linking in notifications

userIdstring

User ID of the comment author (required for API key auth, ignored for JWT auth)

Example request

{
  "content": "This task needs to be completed by end of week (updated)",
  "contextUrl": "https://app.trycomp.ai/org_abc123/risk/rsk_abc123?taskItemId=tki_abc123#task-items",
  "userId": "usr_abc123def456"
}

Response

Comment updated successfully

idstring required

Unique identifier for the comment

contentstring required

Comment content

createdAtstring date-time required

Comment creation timestamp

Example response

{
  "id": "cmt_abc123def456",
  "content": "This task needs to be completed by end of week",
  "author": {
    "id": "usr_abc123def456",
    "name": "John Doe",
    "email": "john.doe@company.com"
  },
  "attachments": [
    {
      "id": "att_abc123def456",
      "name": "document.pdf",
      "type": "application/pdf",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z"
}