Contacts

Generate All Contact Documents

Generate the full document set for this contact. SPENDS CREDITS.

Enqueues the work and returns immediately; poll /contacts/{contact_id}/documents/generation-status for progress. Each document is a model call, so calling this repeatedly on the same contact spends repeatedly.

post/contacts/{contact_id}/documents/generate-all

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/contacts/{contact_id}/documents/generate-all
  • Auth: HTTP bearer

Path parameters

contact_idinteger required

Contact primary key.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataCrmRecordPayload required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say "nothing to report" rather than "we did not tell you".

Changes

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