Update Translation

PUT {{apiPath}}/environments/{{envID}}/translations/{{locale}}

The PUT {{apiPath}}/environments/{{envID}}/translations/{{locale}} operation updates the specified localized UI strings. When successful, this operation returns a 200 OK status message, and an empty response body. It does not return the updated translated strings for the language in the response.

To restore the PingOne provided translation for a string, you can submit a PUT request without providing the translatedText property in the request body:

{
    "key":"flow-ui.label.username"
}

Or, you can submit a PUT request with an empty translatedText value:

{
    "key":"flow-ui.label.username",
    "translatedText":""
}

Request Model

For complete property descriptions, refer to Languages translation request data model.

Property Type Required?

Property	Type	Required?
`key`	String	Required
`translatedText`	String	Required

key

String

Required

translatedText

String

Required

Headers

Authorization Bearer {{accessToken}}

Content-Type application/json

Body

raw ( application/json )

[
  {
     "key":"flow-ui.label.username",
     "translatedText":"Nom"
  },
  {
     "key":"flow-ui.label.password",
     "translatedText":"le mot de passe"
  }
]

Example Request

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/translations/{{locale}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '[
  {
     "key":"flow-ui.label.username",
     "translatedText":"Nom"
  },
  {
     "key":"flow-ui.label.password",
     "translatedText":"le mot de passe"
  }
]'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/translations/{{locale}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"[" + "\n" +
@"  {" + "\n" +
@"     ""key"":""flow-ui.label.username""," + "\n" +
@"     ""translatedText"":""Nom""" + "\n" +
@"  }," + "\n" +
@"  {" + "\n" +
@"     ""key"":""flow-ui.label.password""," + "\n" +
@"     ""translatedText"":""le mot de passe""" + "\n" +
@"  }" + "\n" +
@"]";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/translations/{{locale}}"
  method := "PUT"

  payload := strings.NewReader(`[
  {
     "key":"flow-ui.label.username",
     "translatedText":"Nom"
  },
  {
     "key":"flow-ui.label.password",
     "translatedText":"le mot de passe"
  }
]`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PUT /environments/{{envID}}/translations/{{locale}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

[
  {
     "key":"flow-ui.label.username",
     "translatedText":"Nom"
  },
  {
     "key":"flow-ui.label.password",
     "translatedText":"le mot de passe"
  }
]

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n  {\n     \"key\":\"flow-ui.label.username\",\n     \"translatedText\":\"Nom\"\n  },\n  {\n     \"key\":\"flow-ui.label.password\",\n     \"translatedText\":\"le mot de passe\"\n  }\n]");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/translations/{{locale}}")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/translations/{{locale}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify([
    {
      "key": "flow-ui.label.username",
      "translatedText": "Nom"
    },
    {
      "key": "flow-ui.label.password",
      "translatedText": "le mot de passe"
    }
  ]),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/translations/{{locale}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify([
    {
      "key": "flow-ui.label.username",
      "translatedText": "Nom"
    },
    {
      "key": "flow-ui.label.password",
      "translatedText": "le mot de passe"
    }
  ])

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests
import json

url = "{{apiPath}}/environments/{{envID}}/translations/{{locale}}"

payload = json.dumps([
  {
    "key": "flow-ui.label.username",
    "translatedText": "Nom"
  },
  {
    "key": "flow-ui.label.password",
    "translatedText": "le mot de passe"
  }
])
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/translations/{{locale}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('[\n  {\n     "key":"flow-ui.label.username",\n     "translatedText":"Nom"\n  },\n  {\n     "key":"flow-ui.label.password",\n     "translatedText":"le mot de passe"\n  }\n]');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/translations/{{locale}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump([
  {
    "key": "flow-ui.label.username",
    "translatedText": "Nom"
  },
  {
    "key": "flow-ui.label.password",
    "translatedText": "le mot de passe"
  }
])

response = http.request(request)
puts response.read_body

let parameters = "[\n  {\n     \"key\":\"flow-ui.label.username\",\n     \"translatedText\":\"Nom\"\n  },\n  {\n     \"key\":\"flow-ui.label.password\",\n     \"translatedText\":\"le mot de passe\"\n  }\n]"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/translations/{{locale}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "PUT"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

PingOne Platform APIs

Update Translation

Headers

Body

Example Request

Example Response