https://api.bitsighttech.com/ratings/v1/portfolio/contacts
This is a prerequisite for sending collaboration requests via the Client/Vendor Access Program in bulk. Use this path to assign a point of contact (primary recipient) for companies in your portfolio.
Parameters
* Required.
| Parameter | Values |
|---|---|
company_guid * [Body] Identify the recipient company that’s being tagged with a contact. |
[String] Company unique identifier [entity_guid]. See GET: Portfolio Details. |
friendly_name * [Body] Update the preferred name of the contact. |
[String] See GET: Portfolio Contacts for current user details. |
formal_name * [Body] Update the full name of the contact. |
[String] See GET: Portfolio Contacts for current user details. |
|
* [Body] Update the email address of the contact. The email domain must match a domain that belongs to the company of the contact. |
[String] See GET: Portfolio Contacts for current user details.
Example:
|
phone_number [Body] Update the phone number of the contact. |
[String] See GET: Portfolio Contacts for current user details. |
Example Request
cURL Example
curl -X POST --data-ascii '{
"company_guid": "1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
"friendly_name": "Diane",
"formal_name": "Diane Jones",
"email": "diane@actorsfilms.us",
"phone_number": "555-555-5555"
}' https://api.bitsighttech.com/ratings/v1/portfolio/contacts -u api_token: --header "Content-Type:application/json"
JSON Example
{
"company_guid": "1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
"friendly_name": "Diane",
"formal_name": "Diane Jones",
"email": "diane@actorsfilms.us",
"phone_number": "555-555-5555"
}
- December 14, 2020: Added example cURL request.
- March 31, 2020: Added instructions for getting the values of the query parameters.
Feedback
0 comments
Please sign in to leave a comment.