https://api.bitsighttech.com/ratings/v1/portfolio/entity-custom-ids
Create or update a company's ID (custom company ID).
- PATCH: Highlight Primary or Assign Custom ID is now available and is the preferred method for assigning custom IDs.
- POST: Custom ID in Bulk is now available for editing company IDs in bulk.
Parameters
* Required.
Parameter | Values |
---|---|
guid * [Body] Identify the company to customize. |
[String] Company unique identifier [entity_guid ]. See GET: Portfolio Details. |
name * [Body] Identify the company to customize. |
[String] Company name. |
custom_id [Body] Assign an identifier for the company. |
[String] ID name. |
Example Request
cURL Example
curl -X POST 'https://api.bitsighttech.com/ratings/v1/portfolio/entity-custom-ids' -u api_token: --header "Content-Type:application/json" --data-ascii '{ "guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d", "name":"Black Hills Technologies", "custom_id":"Service Provider 123" }'
JSON Example
{ "guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d", "name":"Black Hills Technologies", "custom_id":"Service Provider 123" }
Troubleshooting
- Double-check the Bitsight company unique identifier used as a reference is valid.
- Ensure the Content-Type header is present.
- Check quotation marks (if using cURL) in outgoing requests.
- January 28, 2022: POST: Custom ID in Bulk [
/v1/portfolio/entity-custom-ids/bulk
] is now available for editing company IDs in bulk. - January 13, 2022: PATCH: Highlight Primary or Assign Custom ID [
/v1/companies/{company_guid}
] is now available and is the preferred method for assigning custom IDs. - April 2, 2020: Published.
Feedback
0 comments
Please sign in to leave a comment.