Skip to main content
POST
Preview Template Import
Validate a template pack before committing to the import. This endpoint performs a dry run, returning a preview of which employees would be created, updated, or skipped — along with any blocking issues that would prevent the import from completing.

Code Examples

Headers

Include your API key in the Authorization header as a Bearer token on every request.
integer
required
ID of the workspace. Required for all Digital Employees API requests.

Request Body

object
required
The template pack payload obtained from Export Template Pack.
integer
required
ID of the agent to import the template into.
string
How to handle naming conflicts with existing employees. Options:
  • skip — keep existing employees, skip conflicting imports (default)
  • rename — auto-rename imported employees to avoid conflicts
  • overwrite — replace existing employees with imported configuration

Response

Returns a preview object describing what would be created, updated, or skipped, without making any changes.

Errors

  • 422 with reason: digital_employee_template_import_blocked — the pack contains blocking issues that prevent import. Inspect the blocking_issues array in the response for details.
  • 422 — invalid pack structure or missing required fields.