SMAO API Documentation
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
AuthorizationBearer <token>

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

In: header

Path Parameters

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/glossary/65f8fa6f1a9d8e0012ab34cd" \  -H "Content-Type: application/json" \  -d '{    "description": "A set of definitions and protocols for building software."  }'
{  "data": {    "id": "string",    "group_id": "string",    "group_name": "string",    "abbreviation": "string",    "name": "string",    "description": "string",    "active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Get a glossary item GET

Get a glossary item

Delete a glossary item DELETE

Delete a glossary item