Skip to main content
PATCH
Update the AI context

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for editing the context fields (tri-state PATCH semantics).

company_description

New value. Set to null to clear.

Maximum string length: 20000
ideal_buyer_personas

New value. Set to null to clear.

Maximum string length: 20000
ideal_customer_profile

New value. Set to null to clear.

Maximum string length: 20000
interest_signals

New value. Set to null to clear.

Maximum string length: 20000

Response

Successful Response

The org's business context, plus its latest generation job for resume.

company_description
string | null
required
created_at
string<date-time>
required
id
string<uuid>
required
ideal_buyer_personas
string | null
required
ideal_customer_profile
string | null
required
interest_signals
string | null
required
last_generated_at
string<date-time> | null
required
latest_generation_job
AiContextGenerationJobReadSchema · object | null
required

The org's most recent generation job, if any — lets a reloaded page resume polling a job that is still running.

source_domain
string | null
required

The domain last used to generate these fields; null until a generation succeeds.

updated_at
string<date-time>
required