Translate Push Copy

POST

api

push

translate

Translate Push Copy

curl --request POST \
  --url https://api.sequenzy.com/api/v1/push/translate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "body": "<string>",
  "localizations": [
    {}
  ],
  "locales": [
    "<string>"
  ],
  "overwrite": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/push/translate"

payload = {
    "title": "<string>",
    "body": "<string>",
    "localizations": [{}],
    "locales": ["<string>"],
    "overwrite": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    body: JSON.stringify('<string>'),
    localizations: [{}],
    locales: ['<string>'],
    overwrite: true
  })
};

fetch('https://api.sequenzy.com/api/v1/push/translate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/push/translate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'body' => '<string>',
    'localizations' => [
        [
                
        ]
    ],
    'locales' => [
        '<string>'
    ],
    'overwrite' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/push/translate"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"localizations\": [\n    {}\n  ],\n  \"locales\": [\n    \"<string>\"\n  ],\n  \"overwrite\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/push/translate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"localizations\": [\n    {}\n  ],\n  \"locales\": [\n    \"<string>\"\n  ],\n  \"overwrite\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/push/translate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"localizations\": [\n    {}\n  ],\n  \"locales\": [\n    \"<string>\"\n  ],\n  \"overwrite\": true\n}"

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

{
  "success": true,
  "localizations": [
    {
      "locale": "de",
      "title": "Deine Bestellung ist unterwegs",
      "body": "Verfolge sie in der App",
      "sourceHash": "9b03c1de",
      "origin": "ai"
    }
  ],
  "translated": ["de"],
  "skipped": [],
  "failed": [],
  "message": "Translated into de."
}

{
  "error": "Add a second language in Settings > Localization to translate pushes."
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: templates:write"
}

Translates a push title and message with AI into the languages in Settings > Localization and returns the versions. Nothing is saved. Use the result as a sequence push step’s localizations (send the whole list in nodeUpdates[].changes.localizations on Update Sequence, or on a push step in Create Sequence) or a push campaign’s. Pass the versions you already have in localizations: by default only languages with no version, and AI versions written from older copy, are translated, and versions a person wrote are kept unless overwrite is true. The response lists every version, old and new. Merge tags are kept exactly and their fallback text is translated. Requires the templates:write scope, like the other content generation endpoints.

Request

string

Main-language title, up to 120 characters. A title or a body is required.

string

Main-language message, up to 500 characters.

object[]

Versions you already have, in the push localizations shape.

string[]

Languages to translate into. Omit for every language except the main one.

boolean

default:"false"

Retranslate versions a person wrote too.

curl -X POST "https://api.sequenzy.com/api/v1/push/translate" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"title":"Your order shipped","body":"Track it in the app"}'

Response fields

object[]

Every version: the ones you passed plus the new translations.

string[]

Languages translated by this request.

object[]

Languages left as they were: { locale, reason } with reason up_to_date or edited.

object[]

Languages that could not be translated: { locale, error }.

string

A one-line summary.

Responses

{
  "success": true,
  "localizations": [
    {
      "locale": "de",
      "title": "Deine Bestellung ist unterwegs",
      "body": "Verfolge sie in der App",
      "sourceHash": "9b03c1de",
      "origin": "ai"
    }
  ],
  "translated": ["de"],
  "skipped": [],
  "failed": [],
  "message": "Translated into de."
}

{
  "error": "Add a second language in Settings > Localization to translate pushes."
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: templates:write"
}

Translate Push Copy

curl --request POST \
  --url https://api.sequenzy.com/api/v1/push/translate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "body": "<string>",
  "localizations": [
    {}
  ],
  "locales": [
    "<string>"
  ],
  "overwrite": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/push/translate"

payload = {
    "title": "<string>",
    "body": "<string>",
    "localizations": [{}],
    "locales": ["<string>"],
    "overwrite": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    body: JSON.stringify('<string>'),
    localizations: [{}],
    locales: ['<string>'],
    overwrite: true
  })
};

fetch('https://api.sequenzy.com/api/v1/push/translate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/push/translate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'body' => '<string>',
    'localizations' => [
        [
                
        ]
    ],
    'locales' => [
        '<string>'
    ],
    'overwrite' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/push/translate"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"localizations\": [\n    {}\n  ],\n  \"locales\": [\n    \"<string>\"\n  ],\n  \"overwrite\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/push/translate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"localizations\": [\n    {}\n  ],\n  \"locales\": [\n    \"<string>\"\n  ],\n  \"overwrite\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/push/translate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"body\": \"<string>\",\n  \"localizations\": [\n    {}\n  ],\n  \"locales\": [\n    \"<string>\"\n  ],\n  \"overwrite\": true\n}"

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

{
  "success": true,
  "localizations": [
    {
      "locale": "de",
      "title": "Deine Bestellung ist unterwegs",
      "body": "Verfolge sie in der App",
      "sourceHash": "9b03c1de",
      "origin": "ai"
    }
  ],
  "translated": ["de"],
  "skipped": [],
  "failed": [],
  "message": "Translated into de."
}

{
  "error": "Add a second language in Settings > Localization to translate pushes."
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: templates:write"
}

​Request

​Response fields

​Responses

Request

Response fields

Responses