Skip to main content
POST
/
v2
/
translations
/
master-json
/
upload
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Operations;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();

$requestBody = new Operations\TranslationControllerUploadMasterJsonEndpointRequestBody(
    file: new Operations\File(
        fileName: 'example.file',
        content: file_get_contents('example.file');,
    ),
);

$response = $sdk->translations->master->upload(
    requestBody: $requestBody
);

if ($response->importMasterJsonResponseDto !== null) {
    // handle response
}
{
  "success": true,
  "message": "Successfully imported translations for 2 resources: welcome-email, password-reset",
  "successful": [
    "welcome-email",
    "password-reset"
  ],
  "failed": [
    "missing-workflow"
  ]
}

Authorizations

Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

Headers

idempotency-key
string

A header for idempotency purposes

Body

multipart/form-data
file
file
required

Master JSON file with locale as filename (e.g., en_US.json)

Response

200 - application/json

Master translations uploaded successfully

success
boolean
required

Overall success status of the import operation

Example:

true

message
string
required

Human-readable message describing the import result

Example:

"Successfully imported translations for 2 resources: welcome-email, password-reset"

successful
string[]

List of resource IDs that were successfully imported

Example:
["welcome-email", "password-reset"]
failed
string[]

List of resource IDs that failed to import

Example:
["missing-workflow"]