BLblackkitetech
Black Kite Bridge

Share a document of a company on the Black Kite Bridge.

Share a document of a company on the Black Kite Bridge.

post/api/v2/bridge/companies/{id}/documents/share

Request

Path parameters

idinteger required
Example:123

The id of the company.

Request body

Emailstring required

The email should end with the main domain of the related company or any domain included in the last scan of the related company.

ReportType'summary' | 'strategy' | 'rsi' required

Report type of given company to share with emails.

Commentstring

Enter a comment to inform the users the document was shared with.

Example request

{
  "Email": "john.doe@acmeinc.com",
  "Comment": "Can you inform me after you review this document?"
}

Response

Success

TrackIdstring

A key in GUID format, which points to the newly shared the Black Kite Bridge document. Use this track id in getBlackKiteBridgeShareStatus action as a URL parameter in order to fetch the results.

Example response

{
  "TrackId": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Changes

No recorded changes to this operation across all 8 revisions of this API.