Create Translation
POST {{apiPath}}/environments/{{envID}}/translations/{{locale}}?module=forms&block=customMessages
The POST /environments/{{envID}}/translations/{{locale}} operation creates custom language translation keys for the specified locale. Applicable only to DaVinci module custom messages.
|
Note: Only the English |
This operation uses SCIM filtering expressions added to the request URL using the module and block query parameters. Specify forms for module and customMessages for block.
Specify the key and translatedText values in the request body.
When successful, this operation returns a 201 Created status message, and the translated strings for the language in the response.
Query parameters
| Parameter | Description |
|---|---|
|
Filters results for the specified UI module. |
|
Filters results for the set of UI strings in the specified module. |
Request Model
For complete property descriptions, refer to Languages translation request data model.
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/translations/{{locale}}?module=forms&block=customMessages' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"key":"forms.fields.customkey2",
"translatedText":"customkey1"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/translations/{{locale}}?module=forms&block=customMessages")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""key"":""forms.fields.customkey2""," + "\n" +
@" ""translatedText"":""customkey1""" + "\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}}?module=forms&block=customMessages"
method := "POST"
payload := strings.NewReader(`{
"key":"forms.fields.customkey2",
"translatedText":"customkey1"
}`)
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))
}
POST /environments/{{envID}}/translations/{{locale}}?module=forms&block=customMessages HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"key":"forms.fields.customkey2",
"translatedText":"customkey1"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"key\":\"forms.fields.customkey2\",\n \"translatedText\":\"customkey1\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/translations/{{locale}}?module=forms&block=customMessages")
.method("POST", 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}}?module=forms&block=customMessages",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"key": "forms.fields.customkey2",
"translatedText": "customkey1"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/translations/{{locale}}?module=forms&block=customMessages',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"key": "forms.fields.customkey2",
"translatedText": "customkey1"
})
};
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}}?module=forms&block=customMessages"
payload = json.dumps({
"key": "forms.fields.customkey2",
"translatedText": "customkey1"
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("POST", 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}}?module=forms&block=customMessages');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "key":"forms.fields.customkey2",\n "translatedText":"customkey1"\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}}?module=forms&block=customMessages")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"key": "forms.fields.customkey2",
"translatedText": "customkey1"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"key\":\"forms.fields.customkey2\",\n \"translatedText\":\"customkey1\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/translations/{{locale}}?module=forms&block=customMessages")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "POST"
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
201 Created
{
"_links": {
"self": {
"href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/translations/en"
}
},
"environment": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
"locale": "en",
"translation": {
"id": "73baddda-9036-4d78-badb-2f302c763c9d",
"key": "forms.fields.customkey1",
"shortKey": "fields.customkey1",
"translatedText": "customkey1"
},
"createdAt": "2025-04-07T13:03:30.221Z",
"id": "4583d6dc-7371-4439-a6b1-434f09cd2880"
}