The includeLocalizations query parameter

BillingCenter can be configured so that you can work with localized values through Cloud API. For information about the required configuration, see the Configuration Guide.

You can specify the language values which are returned in responses using the ?includeLocalizations query parameter. The query parameter accepts a comma-separated list of language typecodes or the special symbol *all to return values for all locale typecodes.

For example:
GET /admin/v1/roles/xc:18391?includeLocalizations=*all
Localized values are returned in the <property name>_Localizations field.
{
  "data": {
    "attributes": {
        ...
        "name": "Privileged Administrator",
        "name_Localizations": {
            "en_US": "Privileged Administrator"
            "fr_FR": "Administrateur privilégié"            
        ...
        }
    }
  }
}

POSTing and PATCHing localized values

You can POST and PATCH localized values. You must include an object <property name>_Localizations for the localized property. For example, the following snippet of a POST includes a localized value for the name of a role. Include the includeLocalizations query parameter to view the localized values in the response.

Command
POST /admin/v1/roles?includeLocalizations=fr_FR
Request body
{
  "data": {
    "attributes": {
        ...
        "name": "Billing Czar",
        "name_Localizations": {
            "fr_FR": "Tzar de la facturation"
        ...
        }
    }
  }
}