Update a workspace

PUT https://api.getpostman.com/workspaces/{{workspaceId}}

Updates a workspace. You can use the following request body properties to update the workspace:

  • name — A string that contains the workspace's new name.
  • type — Optional. A string that contains the workspace type:
    • personal — A personal workspace.
    • team — A team workspace.
  • description — Optional. A string that contains the new workspace description.

Note:

You can change a workspace's type from personal to team, but you cannot change a workspace from team to personal.

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}}", "description"=>"{{workspaceDescription}}", "type"=>"{{workspaceType}}"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"workspace":{"id":"1f0df51a-8658-4ee8-a2a1-d2567dfa09a9","name":"Test Workspace"}}