KNknak
TranslationRequests

Create translation requests

Create one or more translation requests for an asset using a custom translation integration. One translation request is created per code supplied in language_codes, and newly created requests start with a status of requested.

The integration_id must reference a custom_translation integration that belongs to your company. Every code in language_codes must be one of your company's supported translation languages — call GET /translation-languages first to retrieve the valid set.

NOTE: Only custom_translation integrations are supported by this endpoint. Integrations for marketing platforms or other translation providers (Smartling, TransPerfect, Lazarus) are rejected with 422 Unprocessable Entity. Steps to set up a custom translation integration can be found here.

post/translation-requests

Request

Request body

integration_idstring required

ID of the custom_translation integration to use. Must belong to your company.

asset_idstring required

ID of the asset (email or landing page) to translate.

language_codesstring[] required

One or more target language codes. Each must be a supported translation language for your company (see GET /translation-languages). Values must be unique; one translation request is created per code.

notesstring nullable

Optional notes or context stored on each created request. If omitted, the value will be null.

due_datestring nullable

Optional due date for the translation, in ISO 8601 format. If omitted, the value will be null.

Example request

{
  "integration_id": "609ca344d1caa",
  "asset_id": "609ca344d1b1b",
  "language_codes": [
    "fr-CA",
    "es-ES"
  ],
  "notes": "Please prioritize this campaign",
  "due_date": "2026-07-01"
}

Response

Created. Returns the translation requests that were created, one per language code.

Example response

{
  "data": [
    {
      "type": "translation-request",
      "id": "609d7ce223411",
      "attributes": {
        "id": "609d7ce223411",
        "language_code": "zh-CN",
        "source_language_code": "en-US",
        "status": "processing",
        "base_asset_id": "609ca344d1b1b",
        "asset_version_id": "67d19607cbb1d4.78284760",
        "integration_id": "609ca344d1caa",
        "user": {
          "id": "609d7ce223411",
          "name": "John Doe",
          "email": "john.doe@email.com",
          "roles": [
            "Email Creator",
            "Collaborator"
          ]
        },
        "notes": "Need a translation for this asset soon",
        "due_date": "2023-02-08",
        "created_at": "2023-02-08T17:07:12+00:00",
        "updated_at": "2023-02-08T17:07:12+00:00"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.