v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Paths

Replace all translations for a path

🔑

Required OAuth scope: paths:write.

Replaces all translations in the given path with the provided ones. Translations not included are removed.

put/api/v2/paths/{pathId}/translations

Path parameters

pathIdstring ObjectId required

Example:507f1f77bcf86cd799439011

The unique ID of the path.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

Example request

{
  "translations": [
    {
      "lang": "fr",
      "translatorIds": [
        "507f1f77bcf86cd799439011"
      ],
      "translatedFields": {
        "name": "Accueil des employés",
        "description": "Ce chemin vous apprend à intégrer un nouveau collaborateur !"
      }
    }
  ]
}

Response

Returns the updated path translations.

lang'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fi' | 'fr' | 'hr' | 'ht_HT' | 'hu' | 'id' | 'it' | 'ja' | 'kar_MM' | 'ko' | 'lt' | 'mh_MH' | 'nl' | 'nl_BE' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'rw_RW' | 'sk' | 'sl' | 'so_SO' | 'sv' | 'sw_KE' | 'th' | 'ti_ET' | 'tr' | 'uk' | 'zh' | 'am_ET' | 'bn' | 'bs' | 'ca' | 'cy' | 'en_CA' | 'en_GB' | 'es_AR' | 'es_MX' | 'et' | 'fr_CA' | 'gu' | 'he_IL' | 'hy' | 'kk' | 'km' | 'lo' | 'lv' | 'mi' | 'mn_MN' | 'mr' | 'ms' | 'my_MM' | 'nn_NO' | 'or' | 'pa' | 'pt_BR' | 'pt_MZ' | 'rn_BI' | 'si' | 'ta' | 'te' | 'tl_PH' | 'ur' | 'uz' | 'yo_NG' | 'zh_tw' | 'el' | 'hi' | 'sr' | 'ar' | 'vi' | 'zh_HANT' required

The language of the translation.

publishedboolean required

True if the translation is available to users in this language; false otherwise.

translatorIdsstring[] required

The list of unique IDs of the translators assigned to this language.

Example response

[
  {
    "lang": "fr",
    "translatorIds": [
      "507f1f77bcf86cd799439011"
    ],
    "translatedFields": {
      "name": "Accueil des employés",
      "description": "Ce chemin vous apprend à intégrer un nouveau collaborateur !"
    }
  }
]