Notes

Create Record Note

Create a note attached to one or MORE records.

With records, the first entry is the primary record and every entry is linked; without it, entity_type/entity_id name the single record. Every record is authorised for write before anything is stored.

post/notes

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/notes
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

entity_typestring

Record type the note is attached to.

entity_idstring

Id of that record.

contentstring required

Note body.

recordsobject[] nullable

Further records to attach, each {entity_type, entity_id}.

source_urlstring nullable

Where the note was taken.

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.