Skip to main content
POST
/
optimizely
/
v1
/
async
/
upload-xliff-file
Upload translated XLIFF asynchronously
curl --request POST \
  --url https://eu.phrase.com/connectors/optimizely/v1/async/upload-xliff-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Webhook: <x-webhook>' \
  --data '
{
  "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
  "configuration": {},
  "path": {
    "pathType": "ITEM",
    "id": "12345"
  },
  "sourceLocale": "en",
  "targetLocale": "de",
  "storageId": "e48eda63928c4155bez9fdbsaadc15f3"
}
'
{
  "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-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 uploading translated XLIFF back to Optimizely. Reference the stored XLIFF by storageId; the connector parses it and writes the target-locale segments to Optimizely.

​
connectorUuid
string
required

UUID of a connector instance configured in TMS.

Example:

"4282fec0-d2e9-4266-8733-3e634feb7b59"

​
configuration
object
required

Optimizely-specific behavior knobs.

​
path
object
required

Selector inside the Optimizely project — content item, folder, or ROOT.

​
sourceLocale
string
required

Source locale embedded in the XLIFF (Optimizely locale code).

Example:

"en"

​
targetLocale
string
required

Target locale to write into (Optimizely locale code).

Example:

"de"

​
storageId
string
required

Storage ID of the translated XLIFF file (already uploaded to Phrase file storage).

Example:

"e48eda63928c4155bez9fdbsaadc15f3"

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