Public APIGlossary
Update a glossary item
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.
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_idstring
Match
^[a-f0-9]{24}$name?string
Whitespace is trimmed; the trimmed name must be at least 1 character.
Length
1 <= length <= 200abbreviation?string
Length
length <= 100description?string
Length
length <= 5000active?boolean
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://api.smao.ai/api/v1/glossary/string" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"id": "65f8fa6f1a9d8e0012ab34cd",
"group_id": "65a1234567890abcdef01234",
"group_name": "Product terminology",
"abbreviation": "API",
"name": "Application Programming Interface",
"description": "A set of definitions and protocols for building software.",
"active": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "validation_failed",
"message": "Validation failed"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing API key"
}
}{
"error": {
"code": "subscription_required",
"message": "This feature is not available in your current subscription. Please upgrade to a higher plan"
}
}{
"error": {
"code": "forbidden",
"message": "No permission"
}
}{
"error": {
"code": "not_found",
"message": "Not found"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred."
}
}