Contacts

Update Contact Document

Edit a generated document's content or structured data by hand.

put/contacts/{contact_id}/documents/{document_id}

Request

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

Path parameters

contact_idinteger required

Contact id.

document_idstring required

Document id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

contentstring nullable

Replacement document body.

structured_dataobject nullable

Replacement structured payload.

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.