Import Module

POST/import/workspace/{workspaceId}/modules

Imports a module into a workspace from a previously exported payload.

Path Parameters

workspaceIdstringrequired

The unique identifier of the workspace to import the module into.

Request Body

tooljet_versionstringrequired

The ToolJet version the module was exported from.

appobjectoptional

Module definition data from the export step.

appNamestringoptional

Overrides the module name on import.

Error Responses

400

workspaceId is not a valid UUID, workspace does not exist, payload tooljet_version is newer than the server, or definition type is not module.

409

Schema-level TJDB violation (e.g. duplicate column names) — table name collisions are handled by auto-renaming.

451

EXTERNAL_API license not active on the instance.

500

Unhandled error during import — message: Failed to import module.

Request

curl -X POST "https://{your-domain}/api/ext/import/workspace/{workspaceId}/modules" -H "Authorization: Basic <access_token>" -H "Content-Type: application/json" -d '{
"tooljet_version": "3.16.0",
"appName": "My Module"
}'

Response — 200

{
"message": "Module imported successfully."
}