- September 17, 2021: Updated request schema; Added status codes.
https://api.bitsighttech.com/ratings/v1/folders/folder_guid
Edit a folder. Determine how long companies will be in the folder (expiration), edit the folder description, folder name, and sharing options.
Parameters
*Required.
Parameter | Description | Values | ||
---|---|---|---|---|
folder_guidPath |
Identify the folder to edit. | [String] Folder unique identifier [folder_guid ]. See GET: Folder Details. |
||
nameBody |
Assign a new name for the folder. | [String] Folder name. | ||
content_expiry_daysBody |
Set how long companies will remain in the folder before removal. | [Integer] The number of days. | ||
descriptionBody |
Set a new description for the folder. | [String] Folder description. | ||
shared_optionsBody |
Set folder sharing options. | [Object] | ||
is_sharedBody |
Share the folder with a user. | [Boolean] | ||
shared_with_all_usersBody |
Share the folder with all other users. | [Boolean] | ||
shared_withBody |
If sharing with a user (is_shared=true ), identify the user to share the folder with. |
[Array] | ||
|
Provide the user's email address. | [String] Email address. | ||
can_edit_folder_propertiesBody |
Determine if this user is permitted to edit the folder. | [Boolean] | ||
can_edit_folder_contentsBody |
Determine if this user is permitted to edit companies in the folder. | [Boolean] | ||
group_can_edit_contentsBody |
Determine if all users in your group can edit companies in the folder. | [Boolean] | ||
group_can_edit_propertiesBody |
Determine if all users in your group can edit the folder. | [Boolean] |
Example Request
Place the URL within single quotes to avoid any errors.
curl 'https://api.bitsighttech.com/ratings/v1/folders/fcc8b8c4-4fa3-4735-ac14-405ac7855d70' -X PATCH -H 'Content-Type: application/json' --data-binary '{"name":"folder_name"}' --compressed -u api_token:
The server will return all the details of the folder updated with the ones that you patched.
Status Codes
See common errors and status codes.
Code | Description |
---|---|
200 – Okay |
Everything worked as expected. |
401 – Unauthorized |
No valid API token was provided. |
404 – Not Found |
The specified resource could not be found. |