Update a glossary term

import requests
url = "https://example.ada.support/api/v2/glossary/65a17e3f43bec88e2792d0eb"
payload = { "definition": "Money returned to a customer after a completed purchase." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "id": "65a17e3f43bec88e2792d0eb",
  "external_id": "refund-policy",
  "translation_mode": "custom",
  "user_terms": [
    {
      "term": "money back",
      "language": "en"
    }
  ],
  "ai_agent_terms": [
    {
      "term": "refund",
      "language": "en"
    }
  ],
  "voice_detection_enabled": false,
  "definition": "Money returned to a customer after a completed purchase.",
  "voice_pronunciations": null,
  "availability_rules": null
}

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

Authentication

AuthorizationBearer

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

Path parameters

glossary_term_idstringRequired

The id of the glossary term

Request

This endpoint expects an object.

external_idstringOptionalformat: "^[\w +,\-.@#_$%&']+$"1-100 characters

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

translation_modeenumOptional

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

user_termslist of objects or nullOptional

Replaces the existing list. Send null to clear it; omit to leave it unchanged.

ai_agent_termslist of objects or nullOptional

Replaces the existing list. Send null to clear it; omit to leave it unchanged.

voice_detection_enabledbooleanOptional

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

definitionstring or nullOptional1-1000 characters

Send null to clear it; omit to leave it unchanged

voice_pronunciationslist of objects or nullOptional

Replaces the existing list, send null to clear it, or omit to leave it unchanged

availability_rulesobject or nullOptional

Omit to leave the current rule unchanged, send null to clear it, or send a rule to replace it; an unknown variable id or a malformed rule is rejected with a 400

Response

idstringRead-only

The unique identifier for the glossary term

external_idstringformat: "^[\w +,\-.@#_$%&']+$"1-100 characters

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

translation_modeenum

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.

user_termslist of objects or null

The wordings a customer might use, per language. null when none are configured.

ai_agent_termslist of objects or null

The wordings the AI Agent should use, per language. Only meaningful in custom mode; null when none are configured.

voice_detection_enabledboolean

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 or null1-1000 characters

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

voice_pronunciationslist of objects or null

Phonetic respellings applied to the AI Agent’s outgoing speech on voice calls, or null when none are configured

availability_rulesobject or null

The structured rule that gates when this term applies, with variables referenced by id, or null when no rule is attached

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error