Form Templates: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Offer users a gallery of starter templates

Your app has published a set of ready-made templates in the app dashboard for its namespace, such as a registration form, an RSVP form, and a contact form. You want site users to browse them and pick one to start from.

To offer a gallery of starter templates:

1. Call List Form Templates with your app's namespace to retrieve every template published for it.
2. Present the returned templates in your UI. Use each template's name as the title, and its formFields and steps to render a preview of the form.
3. Let the user select a template, and keep its id for the next step.

Let a user start their own form from a template

A site member or visitor wants to build their own form but doesn't want to start from a blank page. Your app lets them pick one of your templates as a starting point and turns it into a fully editable form on their site.

To create a form from a template:

1. Call List Form Templates with your namespace, passing the chosen template's ID in templateIds to retrieve just that template.
2. Read the selected template's formFields, steps, and settings from the response.
3. Call Create Form with those fields and steps to create a form on the user's site, seeded from the template. The new form is fully independent of the template: the user can add, edit, or remove fields and submit the form without affecting the original template or any other user's form.

Retrieve specific templates your app relies on

Your app references a few known templates by ID, such as a default template stored in your app's configuration, and needs to load just those.

To retrieve the templates:

1. Call List Form Templates with your namespace and the templateIds you want to resolve. The response contains only the matching templates in that namespace.
2. Render the returned templates, or use them to seed new forms.