CRUD
WorkspaceGroups

Perform multiple operations with workspace groups

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 workspace groups.<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"<br/>- user permission: "write" or higher

post/api/workspaces/groups/bulk

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/groups/bulk
  • Auth: HTTP bearer

Query parameters

actAsAdminboolean

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

Request body

Response

createdAtstring date-time required

Date-time when this group was created.

defaultPermission'comment' | 'full' | 'read' | 'write'
idstring uuid required

UUID of this group.

lastUpdatedAtstring date-time required

Date-time when this group was last updated.

namestring required

Name of this group.

orderinteger required

Order number of this group for sorting.

parentIdstring uuid

UUID of the parent group (if applicable).

teamIdstring uuid required

UUID of the team which owns this group.

Example response

[
  {
    "_embedded": {
      "workspaces": [
        {
          "description": {
            "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.