Upsert custom phrases

PUT /api/custom-phrases/{languageTag}
OAuth2

Upsert custom phrases for the specified language tag. Upsert means that if the custom phrases already exist, they will be updated. Otherwise, they will be created.

Path parameters

  • languageTag string Required

    Values are af-ZA, am-ET, ar-AR, as-IN, az-AZ, be-BY, bg-BG, bn-IN, br-FR, bs-BA, ca-ES, cb-IQ, co-FR, cs-CZ, cx-PH, cy-GB, da-DK, de, de-DE, el-GR, en, en-GB, en-US, eo-EO, es, es-ES, es-419, et-EE, eu-ES, fa-IR, ff-NG, fi-FI, fo-FO, fr, fr-CA, fr-FR, fy-NL, ga-IE, gl-ES, gn-PY, gu-IN, ha-NG, he-IL, hi-IN, hr-HR, ht-HT, hu-HU, hy-AM, id-ID, ik-US, is-IS, it, it-IT, iu-CA, ja, ja-JP, ja-KS, jv-ID, ka-GE, kk-KZ, km-KH, kn-IN, ko, ko-KR, ku-TR, ky-KG, lo-LA, lt-LT, lv-LV, mg-MG, mk-MK, ml-IN, mn-MN, mr-IN, ms-MY, mt-MT, my-MM, nb-NO, ne-NP, nl-BE, nl-NL, nn-NO, or-IN, pa-IN, pl-PL, ps-AF, pt, pt-BR, pt-PT, ro-RO, ru, ru-RU, rw-RW, sc-IT, si-LK, sk-SK, sl-SI, sn-ZW, sq-AL, sr-RS, sv-SE, sw-KE, sy-SY, sz-PL, ta-IN, te-IN, tg-TJ, th-TH, tl-PH, tr, tr-TR, tt-RU, tz-MA, uk-UA, ur-PK, uz-UZ, vi-VN, zh, zh-CN, zh-HK, zh-MO, zh-TW, or zz-TR.

application/json

Body Required

Responses

  • 201 application/json

    Custom phrases created or updated successfully.

    Hide response attributes Show response attributes object
    • tenantId string Required

      Maximum length is 21.

    • id string Required

      Minimum length is 1, maximum length is 21.

    • languageTag string Required

      Minimum length is 1, maximum length is 16.

    • translation object Required
      Hide translation attribute Show translation attribute object
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 422

    Invalid translation structure.

PUT /api/custom-phrases/{languageTag} 
curl \
 -X PUT https://[tenant_id].logto.app/api/custom-phrases/{languageTag} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"phraseKey1":"new value1","phraseKey2":"new value2"}'
Request example 
{
  "phraseKey1": "new value1",
  "phraseKey2": "new value2"
}
Response examples (201) 
{
  "tenantId": "string",
  "id": "string",
  "languageTag": "string",
  "translation": {
    "input": {
      "password": "Password",
      "username": "Username"
    },
    "action": {
      "sign_in": "Sign In",
      "continue": "Continue"
    }
  }
}