Skip to main content
PATCH
/
organizations
/
{organizationName}
/
workspaces
/
{workspaceName}
Update workspace details
curl --request PATCH \
  --url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/workspaces/{workspaceName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>"
}
'
{
  "name": "<string>",
  "description": "<string>",
  "groupName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "packages": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.credibledata.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$
​
workspaceName
string
required

The unique identifier of the workspace Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

Workspace update data

​
description
string

Updated description of the workspace

Response

Workspace updated successfully

Represents a collaborative workspace for team-based data modeling and analysis

​
name
string

The unique name of the workspace within its organization

Pattern: ^[a-zA-Z0-9_-]+$
​
description
string
​
groupName
string | null

Human-readable description of the workspace's purpose and scope

​
createdAt
string<date-time>

ISO 8601 timestamp indicating when the workspace was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when the workspace was last modified

​
packages
string[]

Array of package resource identifiers that are accessible in this workspace

Path pattern supporting slashes, dots, and dashes

Pattern: ^[a-zA-Z0-9_/.-]+$
​
workspaceType
enum<string>

The type of workspace. PersonalInfra for personal workspaces, Group for shared workspaces.

Available options:
PersonalInfra,
Group