Skip to main content
POST
Upload raw content asynchronously

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 raw content to Contentful. The file must already be in Phrase file storage — reference it by storageId. The connector loads its credentials from TMS using the supplied connectorUuid.

connectorUuid
string
required

UUID of a connector instance configured in TMS.

Example:

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

configuration
object
required

Contentful-specific behavior knobs (tag filter, reference inlining, asset handling, …).

targetLocale
string
required

Target locale to write into (Contentful locale code).

Example:

"de-DE"

storageId
string
required

Storage ID of the raw file (already uploaded to Phrase file storage) to push to Contentful.

Example:

"e48eda63928c4155bez9fdbsaadc15f3"

path
object | null

Selector inside the Contentful space — entry, folder, or ROOT for the entire selection driven by configuration.

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