Create a Glossary Term
Create a new glossary term with definition, synonyms, related terms, references, and governance metadata within a glossary hierarchy using the Collate REST API.
POST
POST /v1/glossaryTerms
Create a Glossary Term
Create a new glossary term within a glossary.Body Parameters
Fully qualified name of the parent glossary term for creating nested terms, for example
BusinessGlossary.Revenue.Array of fully qualified names of related glossary terms.
POST /v1/glossaryTerms
Returns
Returns the created glossary term object with all specified properties and system-generated fields.Response
Related glossary term references.
Create or Update (PUT)
UsePUT /v1/glossaryTerms instead of POST to perform an upsert. If a glossary term with the same fullyQualifiedName already exists, it will be updated; otherwise, a new glossary term is created. The request body is the same as POST.
PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.