Branding

Replace semantic keyword labels

PUT/branding/semantics
branding:writereplace_branding_semanticsDestructiveIdempotent

Sets the token organisation's labels for the keywords listed and returns the full list as GET does; it merges by id, so keywords not sent are left untouched. It needs super admin (else 403 missing_permission) and a service identity cannot. All or nothing: an unknown id is 422 exists and nothing is written. dry_run shows the result without saving it. Emits branding_semantics.updated naming the keywords that changed, only when one did; no email. Sending the earlier labels undoes it.

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 · SemanticsReplace

  • itemsSemanticItem[]Required#

    The keywords to set, each with its labels. Keywords left out keep what they have.

{
  "items": [
    {
      "id": 1,
      "singular_label": "opportunity",
      "plural_label": "opportunities",
      "indefinite_modifier": "an"
    }
  ]
}

Responses

200

The semantic keywords after the change.

Semantic[]
{
  "data": [
    {
      "id": 1,
      "name": "deal",
      "singular_label": "opportunity",
      "plural_label": "opportunities",
      "indefinite_modifier": "an",
      "is_overridden": true
    },
    {
      "id": 2,
      "name": "investor",
      "singular_label": "investor",
      "plural_label": "investors",
      "indefinite_modifier": "an",
      "is_overridden": false
    }
  ]
}
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
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/semantics\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "items": [
    {
      "id": 1,
      "singular_label": "opportunity",
      "plural_label": "opportunities",
      "indefinite_modifier": "an"
    }
  ]
}'