Documents

Import Account Correspondence

Import a batch of correspondence. PARTIAL SUCCESS IS NORMAL.

The response reports imported, skipped and errors and the status stays 200 even when rows failed - read the body, not the status. Send external_id on each item to make the import re-runnable: a row whose external_id is already stored is SKIPPED rather than duplicated.

post/accounts/{account_id}/correspondence/import

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/accounts/{account_id}/correspondence/import
  • Auth: HTTP bearer

Path parameters

account_idstring required

The account.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

Response

Successful Response

dataDocumentPayload required

An open envelope for one document, folder or questionnaire.

Open on purpose: a Library document carries extraction metadata, a questionnaire carries per-provider processing detail, and a generated deal document carries structured_data and highlights whose shape is the generator's rather than this contract's. Pinning those would silently drop whatever the app learned to return that this file had not caught up on.

Changes

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