Import and export forms
Transfer V3 form definitions between organizations using .zenform files, and use bulk import operations to set up custom field definitions and form-service associations. These operations are typically performed during initial setup, data migration, or when standardizing forms across multiple organizations.
Audience: Administrators who manage form definitions and set up form configurations for their organization.
On this page
Before you begin
- You need administrator access to your organization.
- For
.zenformimport and export, the V3 (JSON) form builder must be enabled for your organization. - For bulk field definition imports, prepare your data in advance and verify that no duplicate form codes or field names exist in your organization.
Permission: Export under Export_Admin in the Administrator section of the security role β Required to export forms and lists to Excel, PDF, or CSV from the forms list.
Permission: Add under CustomFields in the Administrator section of the security role β Required to import form definitions and custom field configurations.
Steps
Export a V3 form as a .zenform file
.zenform files are JSON-format files that contain a complete V3 form definition, including all fields, layout, and configuration.
Navigate to Configuration > Forms > Form creation > Custom forms.
Locate the form you want to export in the forms list.
Open the form in the form builder.
Click the Export option.
Note: The system downloads a
.zenformfile containing the form design.
The exported file preserves the form structure but does not include submitted data or form-service associations.
Import a .zenform file
- Navigate to Configuration > Forms > Form creation > Custom forms.
- Click Add, select the form type, and proceed to the DESIGN tab.
- Choose the Import option.
- Select a
.zenformfile from your device. - The system loads the imported form design into the builder.
- Review the form and modify fields or properties as needed.
- Click Save.
Important: If a form with the same code already exists in your organization, the import will fail with a duplicate validation error. Update the form code before saving.
Bulk imports β support-assisted
The three bulk imports below (service custom field definitions, guest custom field definitions, and service-form associations) are support-assisted workflows: there is no self-service UI for them at the time of writing. For each import, prepare the file as described, then submit it to Zenoti Support along with the organization, target center or field group as applicable, and any per-import context.
Import service custom field definitions in bulk
Use bulk import when you need to create many service custom field definitions, forms, custom lists, and form-field associations at once.
- Prepare the import data with the following components:
- Form definitions β Form name, form code (unique per organization), form type, and form properties.
- Custom list entries β List name, description, and list values for dropdown and radio button fields.
- Custom fields β Field name, field type, list binding, validation rules, and display settings.
- Form-field associations β The mapping between forms and the fields they contain.
- Verify that all form codes and field names are unique within your organization. The system rejects records that duplicate existing entries.
- Submit the prepared file to Zenoti Support along with the organization and target center (if applicable).
- Navigate to the custom forms and service custom fields pages to confirm the imported definitions appear correctly.
Import guest custom field definitions in bulk
- Prepare the import data with the following components:
- Field groups β Group name, order, and color for organizing fields into sections.
- Custom list entries β List name, description, and list values for dropdown and radio button fields.
- Custom fields β Field name, field type, list binding, validation rules, and display settings.
- Verify that group names, list names, and field names do not duplicate existing entries.
- Submit the prepared file to Zenoti Support along with the organization and target field group (if any).
- Navigate to the guest custom fields page to confirm the imported definitions appear correctly.
Import service-form associations in bulk
- Prepare the association data. Each record maps a form to a service, including:
- Form identifier β The form code.
- Service identifier β The service code.
- Visit mode β Whether the form applies on the first visit, subsequent visits, or all visits.
- Verify that the referenced forms and services exist in your organization.
- Submit the prepared file to Zenoti Support along with the organization and target center (if applicable).
- Open a service that should have the new association and confirm the form appears in the service's form list.
Tips
- Test
.zenformimports in a development or staging organization before applying to production. - Create the custom list entries that your form references in the target organization before importing the form. If the form references custom lists that do not exist, dropdown fields may appear without options.
- For large-scale custom field setups, use the bulk import process to avoid manually creating each field and association.
Troubleshooting
The Export option is not visible in the form builder. Confirm that the V3 form builder is enabled for your organization. The export option is available only for V3 (JSON) forms. If you are working with a V1 or V2 form, export is not supported β use the service forms report to review submitted data instead.
Import fails with a duplicate validation error. The organization already contains a form with the same form code. Open the
.zenformfile in a text editor, locate the form code field, change it to a unique value, save the file, and attempt the import again.Dropdown fields appear empty after a .zenform import. The imported form references a custom list that does not exist in the target organization. Create the required custom list entries under Configuration > Forms before using the form, then verify the field binding in the form builder.