https://api.bitsighttech.com/ratings/v1/folders/folder_guid/companies
Add companies to an existing folder.
Parameters
* Required.
Parameter | Values |
---|---|
add_companies * [Body] Identify companies to add to the folder. |
[Array] Comma-separated company unique identifiers [entity_guid ]. See GET: Portfolio Details. |
folder_guid * [Path] Identify the folder to edit. |
[String] Folder unique identifier [folder_guid ]. See GET: Folder Details. |
Example Request
Be sure to include the appropriate Content-Type header and send the payload as binary data.
cURL Example
curl 'https://api.bitsighttech.com/ratings/v1/folders/fcc8b8c4-4fa3-4735-ac14-405ac7855d70/companies' -X PATCH -H 'Content-Type: application/json' --data-binary '{ "add_companies":[ "9ecd7b7e-42b4-4d32-99e8-1b65e59b0774", "1263b9c6-af38-4497-84ee-e15efdb065e9" ] }' --compressed -u api_token:
JSON Example
{ "add_companies":[ "9ecd7b7e-42b4-4d32-99e8-1b65e59b0774", "1263b9c6-af38-4497-84ee-e15efdb065e9" ] }
Example Response
In the following example, the name of the folder is “Third Party Risk” and the name of the company being added is called “Example Corp”:
{ "not_added": [ 9ecd7b7e-42b4-4d32-99e8-1b65e59b0774 ], "added": [ "1263b9c6-af38-4497-84ee-e15efdb065e9" ], "companies": [ "331d73bd-11cc-4eca-a92e-87beacec50ff" ], "detail": "Goliath Investments LLC was added to Third Party Risk." }
Response Attributes
Field | Description |
---|---|
not_added Array [ |
Companies that were not successfully added to the folder. |
added Array [ |
Companies that were successfully added to the folder. |
companies Array [ |
Companies currently in the folder. |
detail String |
Messages or notifications related to your request. |
- March 13, 2019: Published.
Feedback
0 comments
Please sign in to leave a comment.