Public APIGlossary
Update a glossary item
PATCH
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.
bearerAuthheader
AuthorizationBearer <token>API key in the Authorization: Bearer <key> header.
Keys are created in the Walido dashboard (Settings → API Keys).
glossary_id*stringMatch
^[a-f0-9]{24}$application/json- body
Partial update - include only the fields you want to change.
group_id cannot be changed via this endpoint.
Properties
1 <= propertiesname?stringWhitespace is trimmed; the trimmed name must be at least 1 character.
Length
1 <= length <= 200abbreviation?stringLength
length <= 100description?stringLength
length <= 5000aliases?array<>Replaces the whole list. Send [] to clear it. Entries follow the same rules as on create.
Items
items <= 20active?booleanUpdated glossary item.
application/json- response
data?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" }}