GTM Context

Scaffold All Documents

Create every Global Context document as an EMPTY template.

Scaffolding is not generation: it creates the rows so the library has a shape, and leaves them empty. Useful when you want to fill documents yourself through PATCH /global-context/documents/{doc_id} rather than have them written for you.

post/global-context/scaffold

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/global-context/scaffold
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataStudioPayload required

An open envelope for one settings block, document or brand artefact.

OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as "the product does not have that setting".

The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.

Changes

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