Collections-Items-Folders

Number of APIs: 4

1. Get a folder

GET {{baseUrl}}/collections/{{collectionId}}/folders/{{folderId}}

Gets information about a folder in a collection.

---

2. Create a folder

POST {{baseUrl}}/collections/{{collectionId}}/folders

Creates a folder in a collection. For a complete list of properties, refer to Folder in the [collection.json schema file]

You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the requests field and the list of request objects in the request body. For more information, see the provided examples.

Note:

It is recommended that you pass the name property in the request body. If you do not, the system uses a null value. As a result, this creates a folder with a blank name.

---

3. Update a folder

PUT {{baseUrl}}/collections/{{collectionId}}/folders/{{folderId}}

Updates a folder in a collection. For a complete list of properties, refer to Folder in the [collection.json schema file]

Note:

This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the name property). The endpoint does not update the entire resource.

---

4. Delete a folder

DELETE {{baseUrl}}/collections/{{collectionId}}/folders/{{folderId}}

Deletes a folder in a collection.

---