Skip to content

Revert a site-text override

DELETE
/site-text/{key}

Removes one UI-text override for one language.

You need system.config.write or system.admin for the whole install; a permission held only for a team doesn’t count. Put the dotted key in the path and language in the query string. The handler trims both and rejects blank values with 400. A missing language parameter is rejected before the permission check. Otherwise signed-out callers get 401 and callers without the permission 403.

A successful removal returns 204 with no body. If there’s no matching row you get 404, so repeating a successful removal normally gets 404. The key and language aren’t checked against the current catalogue or supported locales, so an obsolete override that still exists can be removed.

Removing the row lets the client’s usual fallback chain apply. That doesn’t mean the next screen shows a particular bundled string: a locale fallback or an English override may supply the text, and server or browser caches can still be stale. The server clears this app instance’s override cache and tries to notify other instances; the web client that reverted removes its local entry.

Only this key and language are affected. A concurrent save can recreate the override, so a successful response doesn’t promise it stays gone.

key
required
string

The dotted key of the saved override to remove. It doesn’t have to still exist in the shipped catalogue. Surrounding whitespace is trimmed.

language
required
string

The language of the saved override. Required and nonempty after trimming; matched exactly, with no locale normalization.

The matching override row was removed. No response body.

Malformed request

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed