Skip to main content
POST
Upload xliff content synchronously

Authorizations

Authorization
string
header
required

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

Headers

X-ActionId
string
default:""

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.

Body

application/json

Request body for uploading translated XLIFF back to Contentful. Reference the stored XLIFF by storageId; the connector parses it and writes the target-locale segments to Contentful.

connectorUuid
string
default:""
required

UUID of a connector instance configured in TMS.

Example:

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

sourceLocale
string
default:""
required

Source locale of the translated content (Contentful locale code).

Minimum string length: 1
Example:

"en-US"

targetLocale
string
default:""
required

Target locale to write into (Contentful locale code).

Minimum string length: 1
Example:

"de-DE"

storageId
string
default:""
required

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

Minimum string length: 1
Example:

"e48eda63928c4155bez9fdbsaadc15f3"

configuration
object

Contentful-specific behavior knobs.

path
object

Selector inside the Contentful space targeted by the upload.

{key}
any

Response

Success — the XLIFF was parsed and written. The envelope reports success and any per-entry errors returned by Contentful.

success
boolean
errors
object[]
{key}
any