v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-15367117899.6 KB

Comments

Create a new comment

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

post/v1/comments

Request body

contentstring required

Content of the comment

entityIdstring required

ID of the entity to comment on

entityType'task' | 'vendor' | 'risk' | 'policy' | 'finding' required

Type of entity being commented on

contextUrlstring

Optional URL of the page where the comment was created, 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",
  "entityId": "tsk_abc123def456",
  "entityType": "task",
  "contextUrl": "https://app.betayum.com/org_abc123/vendors/vnd_abc123?taskItemId=tki_abc123#task-items",
  "attachments": [
    {
      "fileName": "document.pdf",
      "fileType": "application/pdf",
      "fileData": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==",
      "description": "Meeting notes from Q4 planning session",
      "userId": "usr_abc123def456"
    }
  ],
  "userId": "usr_abc123def456"
}

Response

Comment created 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"
}