Create a glossary item

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

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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""

active?boolean

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/glossary" \  -H "Content-Type: application/json" \  -d '{    "group_id": "65a1234567890abcdef01234",    "name": "Application Programming Interface",    "abbreviation": "API"  }'

{  "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"  }}

Create a glossary item

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`