Skip to Content
WalidoDocs
Public APIGlossary

Update a glossary item

PATCH
/glossary/{glossary_id}

Partial update - only included fields are changed. group_id cannot be changed via this endpoint; create a new glossary item in the target group instead.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the Walido dashboard (Settings → API Keys).

Path Parameters

glossary_id*string
Match^[a-f0-9]{24}$

Request Body

application/json
  1. body

Partial update - include only the fields you want to change. group_id cannot be changed via this endpoint.

Properties1 <= properties
name?string

Whitespace is trimmed; the trimmed name must be at least 1 character.

Length1 <= length <= 200
abbreviation?string
Lengthlength <= 100
description?string
Lengthlength <= 5000
aliases?array<>

Replaces the whole list. Send [] to clear it. Entries follow the same rules as on create.

Itemsitems <= 20
active?boolean

Response Body

Updated glossary item.

application/json
  1. response
data?
Example Request
curl -X PATCH 'https://api.walido.it/api/v1/glossary/65f8fa6f1a9d8e0012ab34cd' \  -H 'Content-Type: application/json' \  -d '{  "description": "A set of definitions and protocols for building software."}'
Example Response
{  "data": {    "id": "string",    "group_id": "string",    "group_name": "string",    "abbreviation": "string",    "name": "string",    "description": "string",    "aliases": [      "string"    ],    "active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}