Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
Message Overrides

Update Message Overrides

Updates a tenant's pre-built UI message overrides. This is a full replacement: any locale or message override not present in the request is removed. Submit an empty messageOverrides object to clear all overrides. Values are validated against the message override catalog (known ID, allowed placeholders and tags, well-formed markup, and maximum length); invalid values are rejected.

patch/message-overrides

Request body

messageOverridesobject required

Override copy keyed by locale (e.g. en, pt-br), then by message override ID (publicId). Submit an empty object to clear all overrides.

Example request

{
  "messageOverrides": {
    "en": {
      "sms-code-entry.heading": "Enter your code"
    },
    "pt-br": {
      "sms-code-entry.heading": "Insira seu código"
    }
  }
}

Response

OK

messageOverridesobject required

Override copy keyed by locale (e.g. en, pt-br), then by message override ID (publicId). Submit an empty object to clear all overrides.

Example response

{
  "messageOverrides": {
    "en": {
      "sms-code-entry.heading": "Enter your code"
    },
    "pt-br": {
      "sms-code-entry.heading": "Insira seu código"
    }
  }
}