v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB

Translations

Import master translations JSON

Import translations for multiple workflows from master JSON format for a specific locale

post/v2/translations/master-json

Headers

idempotency-keystring

A header for idempotency purposes

Request body

localestring required

The locale for which translations are being imported

masterJsonobject required

Master JSON object containing all translations organized by workflow identifier

Example request

{
  "locale": "en_US",
  "masterJson": {
    "workflows": {
      "welcome-email": {
        "welcome.title": "Welcome to our platform",
        "welcome.message": "Hello there!"
      },
      "password-reset": {
        "reset.title": "Reset your password",
        "reset.message": "Click the link to reset"
      }
    }
  }
}

Response

Master translations imported successfully

successboolean required

Overall success status of the import operation

messagestring required

Human-readable message describing the import result

successfulstring[]

List of resource IDs that were successfully imported

failedstring[]

List of resource IDs that failed to import

Example response

{
  "success": true,
  "message": "Successfully imported translations for 2 resources: welcome-email, password-reset",
  "successful": [
    "welcome-email",
    "password-reset"
  ],
  "failed": [
    "missing-workflow"
  ]
}