Get status of a shared document on the Black Kite Bridge.

Get the status information of document that shared on the Black Kite Bridge.

get/api/v2/bridge/documents/share/status/{trackId}

Request

Base URL
https://app.blackkitetech.com
Auth
OAuth 2
Client credentials
Token URLhttps://app.blackkitetech.com//api/v2/oauth/token
TypeScript
https://skmtc.dev/blackkitetech/apis/black-kite-api/docs/api/v2/bridge/documents/share/status/:trackId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

trackIdstring required

The track id of a document that shared on the Black Kite Bridge.

Response

Success

Status'Success' | 'Queued' | 'Failed' | 'Pending'

The sharing status of the shared document. Queued: The sharing process is queued and is being executed. Failed: The shared report failed to be produced. Please contact your customer success executive with the track id. Success: The sharing process is being completed. Pending: The sharing process has started and is waiting for mail approval.

DocumentIdinteger

The id of the shared document.

Example response

{
  "Status": "Success"
}

Changes

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