Update Glossary Item
PUT /obp/v7.0.0/api/glossary/TITLE
OBPv7.0.0-updateGlossaryItem Roles: CanUpdateGlossaryItem Documentation
Replaces the description of a Glossary Item held in the database.
The title cannot be changed: it is the key. Create a new Item and delete this one to rename.
Only Items stored in the database can be updated. A title that only a static Glossary Item has returns 404 — shipped text is displaced by creating a Dynamic Item with overrides_static_item: true, not by editing it here.
Send the description as it was authored. GET /obp/v7.0.0/api/glossary/TITLE?expanded=false returns exactly that, whereas the default expands the placeholders Items use to quote each other.
Authentication is Required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
TITLE: Dr.
JSON response body fields (11)
- description
- Description of the object. Maximum length is 2000. It can be any characters here.
- html
- html format content
- is_dynamic
- is_dynamic
- markdown
- overrides_static_item
- overrides_static_item
- shadows_static_glossary_item
- shadows_static_glossary_item
- title
- Dr.
- created_at
- created_at
- created_by_user_id
- glossary_item_id
- glossary_item_id
- updated_at
- updated_at
Example request body
{
"description": "The unique identifier of the Bank on this OBP instance.\n\nExample value: gh.29.uk",
"overrides_static_item": true
}Example success response
{
"glossary_item_id": "8f2b1c44-1f2a-4c3d-9a7e-5b6c7d8e9f01",
"title": "Bank.bank_id",
"description": {
"markdown": "The unique identifier of the Bank on this OBP instance.",
"html": "<p>The unique identifier of the Bank on this OBP instance.</p>"
},
"is_dynamic": true,
"overrides_static_item": true,
"shadows_static_glossary_item": true,
"created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"created_at": "2026-10-21T01:45:41Z",
"updated_at": "2026-10-21T01:45:41Z"
}Possible errors (6)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-30571: Glossary Item not found. Please specify a valid value for TITLE.
- OBP-30575: Could not update Glossary Item.
- OBP-50000: Unknown Error.