Glossary

Update a glossary term

Update a glossary term. Only the fields provided in the request body are changed; omitted fields are left as they are.

patch/v2/glossary/{glossary_term_id}

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/glossary/{glossary_term_id}
  • Auth: HTTP bearer

Path parameters

glossary_term_idstring required

The id of the glossary term

Request body

external_idstring

Rename the term's identifier. Rejected with 409 if another term in the AI Agent already uses it.

translation_mode'default' | 'custom'

custom restates detected user_terms using ai_agent_terms; default only surfaces the definition.

voice_detection_enabledboolean

Whether the term is passed to the voice agent to improve how reliably it is recognized in speech.

definitionstring nullable

Send null to clear it; omit to leave it unchanged

Response

OK

idstring required

The unique identifier for the glossary term

external_idstring required

Your own identifier for the term, unique within the AI Agent

translation_mode'default' | 'custom' required

custom tells the AI Agent to answer using the matching ai_agent_terms wording whenever it detects one of the user_terms. default only surfaces the term's definition to the agent (and, with voice_detection_enabled, biases speech recognition) without changing its wording.

voice_detection_enabledboolean required

Whether the term is passed to the voice agent to improve how reliably it is recognized in speech. Requires a voice platform on the AI Agent.

definitionstring nullable required

A business definition of the term, shown to the AI Agent when the term is detected. null when unset.

Changes

No recorded changes to this operation across all 1 revision of this API.