Skip to main content
POST
/
braze_multilang
/
v1
/
async
/
convert-to-xliff
Convert stored raw Braze content to XLIFF asynchronously
curl --request POST \
  --url https://eu.phrase.com/connectors/braze_multilang/v1/async/convert-to-xliff \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Webhook: <x-webhook>' \
  --data '
{
  "rawFiles": [
    {
      "storageId": "e48eda63928c4155bez9fdbsaadc15f3",
      "info": {
        "name": "content-block-123.json"
      }
    }
  ],
  "sourceLocale": "en-US",
  "targetLocale": "de-DE",
  "remoteSourceLocale": "en",
  "remoteTargetLocale": "de"
}
'
{
  "requestId": "e48eda63-928c-4155-bez9-fdbsaadc15f3",
  "webHookUrl": "https://example.tld/my-webhook"
}

Authorizations

​
Authorization
string
header
required

IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer

Headers

​
X-ActionId
string

A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response.

​
X-ResponseType
string

Specify if the response should contain the processed object itself in an application/octet-stream body, or a application/json body with an ID that can be then used to retrieve the object using a /load-content endpoint. Note that for larger files (> 1 MB), it is advised to use the ID option which is also default.

​
X-Webhook
string
required

Required on /async/... endpoints. Bifrost POSTs the operation result to this URL once the connector finishes processing. Omitting this header on an async endpoint returns 400.

Body

application/json

Request body for converting already-stored raw Braze multilingual content into XLIFF 2.0 without re-downloading from Braze.

​
rawFiles
object[]
required

List of stored raw files (each carrying its storageId and original metadata) to convert.

​
sourceLocale
string
required

Source locale used inside the resulting XLIFF (Phrase-side locale code).

Example:

"en-US"

​
targetLocale
string
required

Target locale the XLIFF will be translated into (Phrase-side locale code).

Example:

"de-DE"

​
remoteSourceLocale
string
required

Source locale code as understood by Braze. Mapped to/from sourceLocale to bridge any difference between Phrase locale codes and Braze locale codes.

Example:

"en"

​
remoteTargetLocale
string
required

Target locale code as understood by Braze. Mapped to/from targetLocale.

Example:

"de"

Response

Successful operation. If X-ResponseType is set to 'ID' or no value is sent in the header, the file is saved and can be retrieved by sending a GET request to this endpoint. If X-ResponseType is set to 'OBJECT', the file is returned as a stream.

​
webhookUrl
string

Webhook URL you supplied in the request

​
requestId
string

Request ID you can use to retrieve the result