Translations

Translations

The Translations section allows the defining of many language versions used throughout the Open Loyalty platform. All content elements will appear in the selected default language.

Most of the text that appears to be hard-coded on pages throughout your loyalty platform can be instantly changed to a different language by changing the default language parameter. The Default language is selected during the translation creation process but can be changed at any time in edition mode.

Moreover, during Campaigns and Tier creation/edition processes, an Admin can fulfill the Basic Information section in every language version listed here. For example, if we have Polish and English translations, there is a possibility to provide Basic information on Tiers and Campaigns in both languages.

Thanks to this, changing the default language translates the text word-for-word and references a different translation table that provides the interface text that is used in the Admin and Client cockpit. The text that can be changed includes navigational titles, labels, buttons, and links such as “List of customers” and “Account”, Campaigns and Tier names, descriptions, etc.

Currently, Open Loyalty is available in English.

To open the Translations list, go to Settings -> Translations. All available languages are listed in the table. You can change the number of rows displayed per page by clicking on the arrow icon below the table and picking a handy number from the list.

Adding translations

To add a new language via the API, use this endpoint:

POST /api/language HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "name": "text",
  "code": "text",
  "apiDefault": true,
  "adminDefault": true,
  "order": 1
}

{
  "name": "text",
  "code": "text",
  "apiDefault": true,
  "adminDefault": true,
  "order": 1
}

Managing translations

Editing language

To edit the selected language, click on the overflow button and pick from the expanded list Edit language option, here you can edit such values as Name and Order, as well as change the default language by marking the checkbox.

Editing translation

To edit/add a translation, click on the overflow button and pick from the expanded list Edit translation option. On the 'Edit translation name' screen, you can add the translation for any value in the app. In the middle column, you need to add translation and on the left, you have the default language value present. Click on the record you would like to add (right in the middle) and add a new value. To dismiss this screen, click on the 'X' button and the value will be saved - so if you reopen the Edit translation, the screen will be presented.

To save all the currently active key names, you can retrieve them and save them via this endpoint:

GET /api/translation HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Afterwards, you can translate all the entries and upload them via this endpoint (one key at a time):

GET /api/translation/key/{key} HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "languageCode": "text",
    "key": "text",
    "value": "text",
    "updatedAt": "2025-06-26T10:36:21.054Z"
  }
]

Removing language

To remove the language, click on the overflow button and pick the Remove option from the list. 'Do you want to remove this translation?' pop-up window will show up, confirm your action by clicking on the YES button. The Toast message will appear and the selected translation will be removed from the list.