PUT /workspaces/{workspace_id}

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.

Servers

https://api.getpostman.com

Path parameters

Name	Type	Required	Description
`workspace_id`	String	Yes

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required
`workspace`	Object	No
`workspace.environments[]`	Array	No
`workspace.environments[].id`	String	No
`workspace.environments[].name`	String	No
`workspace.environments[].uid`	String	No
`workspace.name`	String	No
`workspace.description`	String	No
`workspace.monitors[]`	Array	No
`workspace.monitors[].id`	String	No
`workspace.collections[]`	Array	No
`workspace.collections[].id`	String	No
`workspace.collections[].name`	String	No
`workspace.collections[].uid`	String	No
`workspace.mocks[]`	Array	No
`workspace.mocks[].id`	String	No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.