Update a workspace
PUT {{baseUrl}}/workspaces/{{workspaceId}}
Updates a workspace. Include the following properties in the request body:
name
— A string value that contains the workspace's new name.description
— A string value that contains the new workspace description.type
— A string value that contains the new workspace visibility [type] This property does not support the following workspace visibility changes:private
topublic
public
toprivate
private
topersonal
team
topersonal
public
topersonal
for a team user
Important
We deprecated linking collections or environments between workspaces. We do not recommend that you do this.
If you have a linked collection or environment, note the following:
- The endpoint does not create a clone of a collection or environment.
- Any changes you make to a linked collection or environment changes them in all workspaces.
- If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.
Request Body
{"workspace"=>{"name"=>"{{workspaceName}}", "type"=>"{{workspaceType}}", "description"=>"{{workspaceDescription}}"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"workspace":{"id":"1f0df51a-8658-4ee8-a2a1-d2567dfa09a9","name":"Test Workspace"}}