Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

workspaces

Update the workspace with the specified id.

You have to be a member of the Contract’s scope and need workspaces.workspace.edit permission to access this resource. To update the type of Workspace you need workspaces.workspace.edit_type permission.

patch/workspaces/{workspace_id}

Path parameters

workspace_idstring required

Workspace identifier

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "My workspace",
      "flow_stats_enabled_default": true
    }
  }
}

Response

OK

metaobject required

Example response

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/workspaces/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "name": "Workspace Name",
      "flow_stats_enabled_default": true
    },
    "relationships": {
      "contract": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/contracts/5b4f337bff4304610483ba67"
        }
      },
      "members": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ],
        "links": {
          "self": "/v2/workspaces/5b4f337bff4304610483ba67/members"
        }
      }
    }
  },
  "included": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/members/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "first_name": "John",
        "last_name": "Smith",
        "roles": [
          "integrator"
        ],
        "email": "test@example.com"
      }
    }
  ],
  "links": {
    "self": "/v2/workspaces/5b4f337bff4304610483ba67"
  }
}