Skip to main content
PATCH
Update the AI context

Authorizations

X-API-Key
string
header
required

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: 10000
ideal_buyer_personas

New value. Set to null to clear.

Maximum string length: 10000
ideal_customer_profile

New value. Set to null to clear.

Maximum string length: 10000
interest_signals

New value. Set to null to clear.

Maximum string length: 10000
social_proof

New value. Set to null to clear.

Maximum string length: 10000
voice

The company voice: spelling, formality, what the company calls its product and its buyers, jargon it avoids, how technical it gets. Not length or punctuation. Set to null to clear.

Maximum string length: 600

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.

social_proof
string | null
required
source_domain
string | null
required

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

updated_at
string<date-time>
required
voice
string | null
required

How the company words things: spelling, formality, what it calls its product and its buyers, jargon it avoids. The outbound agent matches it in every message.