Skip to content

Update Meeting Extraction Settings

PUT
/org/settings/docs/meetings

Replace the meeting extraction settings.

Declared BEFORE PUT /org/settings/docs/{scope}: the other way round the parameter route matches first, binds scope to “meetings”, and the Literal rejects it - a 422 on a route that exists.

Every block defaults to EMPTY, so omitting one is not the same as leaving it alone. Read the current settings, change what you need, send the whole object back.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors campaign_builder.schemas.settings.UpdateMeetingExtractionSettingsRequest.

Every field defaults to an EMPTY block, and the app treats the request as the new state for each scope it receives - so omitting a scope is not the same as sending it empty. Send the whole object you read back.

The nested blocks are the app’s own models; see the module docstring.

object
customer

Meetings with an existing customer.

object
custom_fields

Org-defined custom fields to extract

Array<object>

Org-defined field to extract from meeting transcripts.

object
field_type

Output type expected from the extractor

string
default: text
Allowed values: text boolean list
instruction

Instruction describing what to extract

string
""
key

Stable key for the extracted field

string
""
label
required

Display label shown in admin and downstream UI

string
custom_terms

Vocabulary terms, acronyms, and product names to recognize

Array<object>

Vocabulary term or acronym with optional meaning/explanation.

object
explanation

Optional explanation of what the term means or why it matters

string
""
term
required

A term, acronym, or phrase the extractor should recognize

string
extract_fields

Structured outputs that should always be extracted

Array<string>
listen_for

Signals and topics the extractor should prioritize

Array<string>
internal

Internal meetings - every attendee is on an internal domain.

object
custom_fields

Org-defined custom fields to extract

Array<object>

Org-defined field to extract from meeting transcripts.

object
field_type

Output type expected from the extractor

string
default: text
Allowed values: text boolean list
instruction

Instruction describing what to extract

string
""
key

Stable key for the extracted field

string
""
label
required

Display label shown in admin and downstream UI

string
custom_terms

Vocabulary terms, acronyms, and product names to recognize

Array<object>

Vocabulary term or acronym with optional meaning/explanation.

object
explanation

Optional explanation of what the term means or why it matters

string
""
term
required

A term, acronym, or phrase the extractor should recognize

string
extract_fields

Structured outputs that should always be extracted

Array<string>
listen_for

Signals and topics the extractor should prioritize

Array<string>
meeting_grounding

Company identity the extractor grounds on: canonical name, internal domains, aliases.

object
brand_aliases

Known brand, alias, or product names that resolve to canonical entities

Array<object>

Alias, brand, or product name that should resolve to a canonical entity.

object
alias
required

Brand, alias, or product term as it may appear in transcripts

string
canonical_name
required

Canonical company or product name this alias resolves to

string
explanation

Optional explanation of the relationship or how this alias should be interpreted

string
""
canonical_company_name

Canonical internal company name that should be used in summaries and task interpretation

string
""
internal_domains

Email domains that identify internal attendees

Array<string>
participant_rules

Rules that explain how participant and domain evidence should be interpreted

Array<string>
prospect

Meetings with a prospect.

object
custom_fields

Org-defined custom fields to extract

Array<object>

Org-defined field to extract from meeting transcripts.

object
field_type

Output type expected from the extractor

string
default: text
Allowed values: text boolean list
instruction

Instruction describing what to extract

string
""
key

Stable key for the extracted field

string
""
label
required

Display label shown in admin and downstream UI

string
custom_terms

Vocabulary terms, acronyms, and product names to recognize

Array<object>

Vocabulary term or acronym with optional meaning/explanation.

object
explanation

Optional explanation of what the term means or why it matters

string
""
term
required

A term, acronym, or phrase the extractor should recognize

string
extract_fields

Structured outputs that should always be extracted

Array<string>
listen_for

Signals and topics the extractor should prioritize

Array<string>
shared

Applied to every meeting, on top of the per-scope block.

object
custom_fields

Org-defined custom fields to extract

Array<object>

Org-defined field to extract from meeting transcripts.

object
field_type

Output type expected from the extractor

string
default: text
Allowed values: text boolean list
instruction

Instruction describing what to extract

string
""
key

Stable key for the extracted field

string
""
label
required

Display label shown in admin and downstream UI

string
custom_terms

Vocabulary terms, acronyms, and product names to recognize

Array<object>

Vocabulary term or acronym with optional meaning/explanation.

object
explanation

Optional explanation of what the term means or why it matters

string
""
term
required

A term, acronym, or phrase the extractor should recognize

string
extract_fields

Structured outputs that should always be extracted

Array<string>
listen_for

Signals and topics the extractor should prioritize

Array<string>

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