Skip to content

Save Buying Journey Interview

POST
/global-context/documents/buying-journey/interview

Record how this organisation actually sells, in its own words.

The answers are injected as HIGHEST-PRIORITY grounding the next time the buying journey is generated - they outrank the scraped and inferred material. The document must already exist; this grounds it, it does not create it.

Declared with a literal buying-journey second segment, so it does not collide with /documents/{doc_id}/feedback.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The typed form of the untyped dict body the interview route takes.

The app reads answers and 400s when it is empty. Typed so that is a 422, and so the shape is discoverable.

object
answers
required

Structured interview answers about how this organisation sells. Injected as highest-priority grounding the next time the buying journey document is generated.

object
>= 1 properties
key
additional properties
any

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string