Update space

Update a space in a project

PATCH /api/v1/projects/{projectUuid}/spaces/{spaceUuid}

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "path": "<string>",
    "colorPaletteUuid": "<string>",
    "inheritParentPermissions": true,
    "parentSpaceUuid": "<string>",
    "childSpaces": [
      {
        "name": "<string>",
        "projectUuid": "<string>",
        "organizationUuid": "<string>",
        "uuid": "<string>",
        "inheritParentPermissions": true,
        "pinnedListUuid": "<string>",
        "pinnedListOrder": 123,
        "slug": "<string>",
        "parentSpaceUuid": "<string>",
        "path": "<string>",
        "appCount": 123,
        "childSpaceCount": 123,
        "dashboardCount": 123,
        "chartCount": 123,
        "deletedBy": {
          "lastName": "<string>",
          "firstName": "<string>",
          "userUuid": "<string>"
        },
        "deletedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "slug": "<string>",
    "pinnedListOrder": 123,
    "pinnedListUuid": "<string>",
    "groupsAccess": [
      {
        "groupName": "<string>",
        "groupUuid": "<string>"
      }
    ],
    "access": [
      {
        "hasDirectAccess": true,
        "userUuid": "<string>",
        "avatarUrl": "<string>",
        "isInternal": true,
        "email": "<string>",
        "lastName": "<string>",
        "firstName": "<string>"
      }
    ],
    "dashboards": [
      {
        "name": "<string>",
        "projectUuid": "<string>",
        "organizationUuid": "<string>",
        "uuid": "<string>",
        "pinnedListUuid": "<string>",
        "pinnedListOrder": 123,
        "updatedAt": "2023-11-07T05:31:56Z",
        "spaceUuid": "<string>",
        "views": 123,
        "firstViewedAt": "<string>",
        "verification": {
          "verifiedAt": "2023-11-07T05:31:56Z",
          "verifiedBy": {
            "lastName": "<string>",
            "firstName": "<string>",
            "userUuid": "<string>"
          }
        },
        "description": "<string>",
        "updatedByUser": {
          "userUuid": "<string>",
          "firstName": "<string>",
          "lastName": "<string>"
        },
        "validationErrors": [
          {
            "createdAt": "2023-11-07T05:31:56Z",
            "error": "<string>",
            "validationUuid": "<string>",
            "validationId": 123
          }
        ]
      }
    ],
    "projectUuid": "<string>",
    "queries": [
      {
        "name": "<string>",
        "projectUuid": "<string>",
        "organizationUuid": "<string>",
        "uuid": "<string>",
        "pinnedListUuid": "<string>",
        "slug": "<string>",
        "spaceUuid": "<string>",
        "dashboardUuid": "<string>",
        "spaceName": "<string>",
        "dashboardName": "<string>",
        "pinnedListOrder": 123,
        "updatedAt": "2023-11-07T05:31:56Z",
        "firstViewedAt": "2023-11-07T05:31:56Z",
        "views": 123,
        "verification": {
          "verifiedAt": "2023-11-07T05:31:56Z",
          "verifiedBy": {
            "lastName": "<string>",
            "firstName": "<string>",
            "userUuid": "<string>"
          }
        },
        "description": "<string>",
        "updatedByUser": {
          "userUuid": "<string>",
          "firstName": "<string>",
          "lastName": "<string>"
        },
        "validationErrors": [
          {
            "createdAt": "2023-11-07T05:31:56Z",
            "error": "<string>",
            "validationUuid": "<string>",
            "validationId": 123
          }
        ]
      }
    ],
    "inheritsFromOrgOrProject": true,
    "name": "<string>",
    "uuid": "<string>",
    "organizationUuid": "<string>",
    "breadcrumbs": [
      {
        "hasAccess": true,
        "uuid": "<string>",
        "name": "<string>"
      }
    ]
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

projectUuid · string · required

The uuid of the space's parent project

spaceUuid · string · required

The uuid of the space to update

Body

application/json

name · string · required

colorPaletteUuid · string | null

projectMemberAccessRole · enum<string> | null

When set, all project members get this role on the space

Available options: viewer, editor, admin

inheritParentPermissions · boolean

Response

200

application/json

Updated

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok