Upload translation files

Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json

Authorization

Authorization<token>

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

In: header

Authorization<token>

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

In: header

Request Body

multipart/form-dataRequired

Translation files upload body details

resourceIdRequiredstring

The resource ID to associate localizations with. Accepts identifier or slug format

resourceTypeRequiredstring

The resource type to associate localizations with

Value in: "workflow" | "layout"

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

Upload results

totalFilesRequirednumber

Total number of files processed

successfulUploadsRequirednumber

Number of files successfully uploaded

failedUploadsRequirednumber

Number of files that failed to upload

errorsRequiredarray<string>

List of error messages for failed uploads

export interface Response {
  /**
   * Total number of files processed
   */
  totalFiles: number;
  /**
   * Number of files successfully uploaded
   */
  successfulUploads: number;
  /**
   * Number of files that failed to upload
   */
  failedUploads: number;
  /**
   * List of error messages for failed uploads
   */
  errors: string[];
}

curl -X POST "https://api.novu.co/v2/translations/upload" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>" \
  -F resourceId="welcome-email" \
  -F resourceType="workflow"

{
  "totalFiles": 3,
  "successfulUploads": 2,
  "failedUploads": 1,
  "errors": [
    "Invalid JSON in file: es-ES.json"
  ]
}

Authorization

Request Body

Header Parameters

Response Body

On this page