Embedded APIResourcesRecipe lifecycle management

Import package into a customer workspace

Import a package in zip file format into a specified folder in a customer workspace. This endpoint allows an API client to create or update assets, such as recipes, lookup tables, event topics, and message templates, through package imports. This is an asynchronous request. Use the Get package status endpoint to get details of the imported the package. The input (zip file) is an application/octet-stream payload containing package content. The query parameter restart_recipes must be set to true if the running recipes need to be restarted upon import.

API CLIENT ACCESS
Access to this endpoint allows an API client to create or update other assets, such as recipes, lookup tables, event topics, and message templates, through package imports.
PACKAGE IMPORT RATE LIMIT
Workato enforces a strict limit of 500 package import requests per hour per workspace. If this limit is exceeded, the system denies additional requests until the following hour when the request allowance resets.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
folder_idstringRequired
Folder ID.
restart_recipesstringOptional

Value must be true to allow the restarting of running recipes during import. Packages cannot be imported if there are running recipes and this parameter equals false or is not provided.

include_tagsbooleanOptional

Specifies whether to preserve tags assigned to assets when importing the package into the folder. Tags are excluded from the import when set to false. Set to false by default.

folder_id_for_home_assetsstringOptional

The ID of a folder to store assets in instead of the root folder. The folder specified must be accessible to the API client and cannot be the root folder. Defaults to blank.

FOLDER_ID_FOR_HOME_ASSETS SOMETIMES REQUIRED
The folder_id_for_home_assets parameter is required if you’re importing a package that contains root folder assets or if the customer’s workspace Home assets folder has been converted to a Home assets project. Refer to the Home assets project section for more information.

Response

Success response
idinteger or null
Unique identifier for the operation.
operation_typestring or null
The type of operation performed.
statusstring or null
The status of the operation.

Errors