1. Docs
  2. API Reference
  3. BrandingTextKeyDto

BrandingTextKeyDto

Example

JSON
{
  "key": "authHosted.login.signInHeading",
  "locale": "en",
  "page": "login",
  "page_title": "Sign in",
  "preview_state": "Password",
  "name": "Heading",
  "kind": "heading",
  "default": "Sign in",
  "placeholders": [
    "name"
  ],
  "max_length": 80
}

Properties

10 properties 10 required

key string Required

What `text_overrides` names the text by.

ExampleauthHosted.login.signInHeading
locale string Required

The locale this entry's wording is in.

Exampleen
page string Required

The hosted page or email the text shows on, by the `id` the preview list returns.

Examplelogin
page_title string Required

That page's or email's title.

ExampleSign in
preview_state string Required

A state of that page that shows the text, by the `id` the preview list returns: what to preview to see it.

ExamplePassword
name string Required

A plain name for the text.

ExampleHeading
kind enum Required

What the text is: a `heading`, `label`, `button` or `helper`.

Enumheadinglabelbuttonhelper
default string Required

The wording the page shows when the text is not overridden.

ExampleSign in
placeholders array of string Required

The placeholders an override must keep, each written in double braces, such as `{{name}}`. Empty for most texts.

Examplename
max_length number Required

The longest an override may be, in characters.

Example80
Was this page helpful?

Tell us how we can improve this guide.