Branding

Replace a translation

PUT/branding/translations/{id}

Replaces the English text and the modifier of the translation with this key and returns it; other stored locales are kept. Send text with en only, and always send modifier: null stores an empty string. It is tenant-wide, changing what every organisation sees, so it needs super admin (else 403 missing_permission) and a service identity cannot. An unknown key is 404 and nothing is created. dry_run shows the result without saving it. Emits branding_translation.updated only when something changed; no email. Sending the earlier values undoes it.

Path parameters

  • idstringRequired#

    The translation's key, such as deal. Translations are keyed by their text key, not a UUID, and the key is at most 255 characters.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · TranslationReplace

  • textobjectRequired#

    The new text. Only English is accepted.

  • modifierstring | nullRequired#

    The word that goes before the text, such as a or an. Always send it: null stores an empty string.

{
  "text": {
    "en": "opportunity"
  },
  "modifier": "an"
}

Responses

200

The translation after the change.

Translation
{
  "data": {
    "id": "string",
    "key": "string",
    "group": "string",
    "text": {
      "en": "string"
    },
    "modifier": "string",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PUT https://your-org-domain/kong/core/api/v2/branding/translations/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "text": {
    "en": "opportunity"
  },
  "modifier": "an"
}'