Skip to main content

Update Glossary

Update glossary metadata.

Endpoint​

PATCH /api/v4/glossaries/{id}

Request Type​

type UpdateGlossaryRequest = {
  name?: string;
  description?: string;
  is_active?: boolean;
};

Request Fields​

FieldTypeRequiredDescription
namestringNoUpdated glossary name
descriptionstringNoUpdated description
is_activebooleanNoActive status

Response Type​

type GlossaryResponse = {
  data: Glossary;
};
type Glossary = {
  id: number;
  name: string;
  description: string | null;
  source_language: string;
  target_language: string;
  entry_count: number;
  is_active: boolean;
  deepl_glossary_id: string | null;
  google_glossary_id: string | null;
  organization_id: number;
  created_at: string;
  last_modified: string;
  entries?: GlossaryEntry[];
};

Notes​

  • All fields in the request are optional
  • Only provided fields will be updated
  • Returns the full updated glossary object
  • The is_active field controls whether the glossary is used for translations