CRUD
Comments

Update an existing comment

Returns updated comment with its sanitised data.<br/>Requirements:<br/>- auth-client scopes: "workspace:comment"<br/>- user permission: "comment" or higher

put/api/workspaces/{workspaceId}/comments/{commentId}

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/{workspaceId}/comments/{commentId}
  • Auth: HTTP bearer

Path parameters

workspaceIdstring uuid required
commentIdstring uuid required

Query parameters

actAsAdminboolean

Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.

Request body

Example request

{
  "content": {
    "blocks": [
      {
        "content": [
          {
            "content": "hello world",
            "type": "text"
          }
        ],
        "type": "paragraph"
      }
    ],
    "richText": true
  }
}

Response

_embeddedItemCommentEmbed required
createdAtstring date-time required
idstring uuid required
itemIdstring uuid required
lastUpdatedAtstring date-time required

Example response

{
  "content": {
    "blocks": [
      {
        "content": [
          {
            "content": "hello world",
            "type": "text"
          }
        ],
        "type": "paragraph"
      }
    ],
    "richText": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.