Skip to Content
WalidoDocs
Public APIGlossary

Create a glossary item

POST
/glossary

Creates a new glossary item inside a glossaries-type group. The referenced group_id must belong to your organization and have type: glossaries.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
group_id*string
Match^[a-f0-9]{24}$
name*string

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

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

Spoken forms of the term as the speech recognizer tends to write them (for example Michel for Mitel). Each entry is trimmed; an empty or whitespace-only entry is rejected with 400. Duplicates are dropped case-insensitively, keeping the first spelling.

Itemsitems <= 20
Default[]
active?boolean
Defaulttrue

Response Body

Created.

application/json
  1. response
data?
Example Request
curl -X POST 'https://api.walido.it/api/v1/glossary' \  -H 'Content-Type: application/json' \  -d '{  "group_id": "65a1234567890abcdef01234",  "name": "Application Programming Interface",  "abbreviation": "API",  "aliases": [    "A P I"  ]}'
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"  }}