https://api.bitsighttech.com/ratings/v1/companies/company_guid
Highlight a primary for your organization or assign a custom ID for a portfolio company.
Parameters
* Required.
| Parameter | Values |
|---|---|
company_guid * [Path] Identify the company to edit. |
[String] Company unique identifier [entity_guid]. See GET: Portfolio Details. |
guid * [Body] Identify the company to assign as the primary. |
[String]
|
custom_id [Body] Assign the ID. |
[String]
|
Example Requests
Highlight primary:
curl 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"contents": {"primary_company": {"guid": "1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9"}}}' --compressed
Assign custom ID:
curl 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"contents": {"custom_id": "Abc123"}}' --compressed
Errors and Status Codes
See the common errors and status codes.
| Code | Description |
|---|---|
200 – Okay |
Everything worked as expected. Returns updated company details. |
400 – Bad Data |
This can often be due to missing a required parameter. |
401 – Unauthorized |
No valid API token was provided. |
404 – Not Found |
The assigned company does not exist. |
January 13, 2021: Published.
Feedback
0 comments
Please sign in to leave a comment.