CRUD
Comments

Perform multiple operations with comments

Accepts a list of create/update/patch/delete operations (see the request model for more details).<br/> Each operation can target a single or multiple comments.<br/> Returns a list of results for each input operation including errors.<br/> Guarantees that the size and order of the returned results matches the order of input operations.<br/>Requirements:<br/>- auth-client scopes: "workspace:comment"<br/>- user permission: "comment" or higher

post/api/workspaces/{workspaceId}/comments/bulk

Request

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

Path parameters

workspaceIdstring 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

[
  {
    "resource": {
      "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.