POST: Create a Folder

https://api.bitsighttech.com/ratings/v1/folders

Create a new folder. Folders can be used to organize your portfolio to better understand the security performance of certain groups of companies, such as IT vendors.

Parameters

* Required.

name

* Required.

[Query] Assign a name for the folder.

Value: [String] The intended name for the folder.

description

[Query] Assign a description for the folder.

Value: [String] A description for the folder.

content_expiry_days

[Query] Set how long companies will remain in the folder before being removed.

Value: [Integer] The number of days.

Example Request

The minimum requirement for creating a folder is to specify a name:

cURL Example

curl 'https://api.bitsighttech.com/ratings/v1/folders'
 -H 'Content-Type: application/json'
 --data-binary '{"name":"My Folder"}'
 --compressed 
 -u api_token:

JSON Example

{
  "name":"My Folder"
}
  • December 14, 2020: Added example JSON body.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.