Logo
15_Days_of_Postman_-_for_testers_IvanKo API Documentation

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 to public, public to private, and private to personal for Free and Basic [plans]
    • public to personal for team users only.

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.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status OK

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



Curl
curl -X PUT 'https://api.getpostman.com/workspaces/workspaceId' -H 'Content-Type: application/json' -d '{"workspace":{"name":"workspaceName","type":"workspaceType","description":"workspaceDescription"}}'

ENDPOINTS