Update an element or folder
PUT {{baseUrl}}/network/private/{{elementType}}/{{elementId}}
Updates an element or folder in your [Private API Network] When you call this endpoint, the elementType
property must be the api
, folder
, collection
, or workspace
value.
The elementId
value is the api
, folder
, or workspace
element's ID. For collection
, this value is the collection's UID (userId
-collectionId
).
Include the following in the request body object:
elementType
— The Private API Network element type. The object's name must be one of the following:api
folder
collection
workspace
In the elementType
object, include the following values:
parentFolderId
— A string value that contains the element's new Private API Network folder ID.
For Collections:
summary
— A string value that contains the collection's new summary.
For Private API Network Folders:
You can include the following optional properties:
description
— A string value that contains the folder's new description.name
— A string value that contains the folder's new name.
RESPONSES
status: OK
{"id":1,"parentFolderId":0,"updatedAt":"2022-12-07T20:27:06.000Z","updatedBy":12345678,"createdBy":12345678,"createdAt":"2022-12-07T17:04:23.000Z","name":"Billing","description":"The Billing API.","type":"folder"}