Update Workspace

PUT

/workspaces/{workspace_id}

Workspaces

This endpoint allows you to update a workspace and update it's association to entities like collections, environments, mocks and monitors using their uid.

On successful updation of the workspace, the response returns the workspcae name and id.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Note : The endpoint expects you to send the desired state of the workspace in terms of the associated entities so be careful when trying to update these entities.

For eg. if your workspace has collections A and B, and in the update call, you send C's uid in the collections array, then A and B would be removed from the workspace and C would be added.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.getpostman.com/workspaces/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workspace": {
        "collections": [
            {
                "id": "e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d",
                "name": "Straw hats",
                "uid": "8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d"
            }
        ],
        "description": "Some description",
        "environments": [
            {
                "id": "83a1aaa2-a204-4bd8-9b92-4d486918906b",
                "name": "env",
                "uid": "8154-83a1aaa2-a204-4bd8-9b92-4d486918906b"
            }
        ],
        "mocks": [
            {
                "id": "cda672ef-1375-40e9-baee-e20ece8d7b65"
            }
        ],
        "monitors": [
            {
                "id": "1e889bd2-3862-4be0-b2c2-9b1fe9673aec"
            }
        ],
        "name": "New Workspace updated"
    }
}'

Response Example

200 - Successful Response

{
  "workspace": {
    "id": "cfbcd9bf-cc8b-4d6f-b8ef-440a3e49e29f",
    "name": "New Workspace"
  }
}

Request

Path Params

workspace_id

string

required

Body Params application/json

workspace

object

optional

collections

array [object {3}]

optional

description

string

optional

Example:

Some description

environments

array [object {3}]

optional

mocks

array [object {1}]

optional

monitors

array [object {1}]

optional

name

string

optional

Example:

New Workspace updated

Examples

Responses

🟢200Successful Response

application/json

Body

workspace

object

optional

string

optional

Example:

cfbcd9bf-cc8b-4d6f-b8ef-440a3e49e29f

name

string

optional

Example:

New Workspace

🟠403Not enough permissions

🟠404Specified workspace/entities do not exist

Modified at 2023-08-15 05:41:04

Single workspace