Data Forms
Custom form management. Create forms with sections and questions, publish them, and send to clients individually or in bulk. Questions can map to client fields, custom fields, or be form-specific.
-
GET List DataFormsLists all DataForms for the given tenant./tenants/{tenant}/data-forms
-
POST Create DataFormCreates a new DataForm for the specified tenant./tenants/{tenant}/data-forms
-
GET Get DataFormGets a DataForm for the specified tenant./tenants/{tenant}/data-forms/{code}
-
PUT Update DataFormUpdates a DataForm for the specified tenant./tenants/{tenant}/data-forms/{code}
-
DELETE Delete DataFormDeletes a DataForm for the specified tenant./tenants/{tenant}/data-forms/{code}
-
GET List Library DataFormsList all DataForms available in the library as templates. Use optional 'search' query parameter to filter by Code, Name, or Description./tenants/{tenant}/data-forms/library
-
GET Get Library DataFormGet details of a specific DataForm template from the library/tenants/{tenant}/data-forms/library/{code}
-
PUT Revert DataForm to LibraryReverts the DataForm to the current library template version, overwriting any local edits. The DataForm's code is preserved so it remains addressable .../tenants/{tenant}/data-forms/{code}/library-version
-
POST Create DataForm from LibraryCreates a new DataForm for the tenant based on a library template. Automatically creates the form category if it doesn't exist. Re-imports of the same.../tenants/{tenant}/data-forms/library/{libraryCode}/create
-
POST Send DataForm to ClientSends a published form to a single client, creating a form request and sending a notification email./tenants/{tenant}/data-forms/{code}/send
-
POST Send DataForm to Multiple ClientsSends a published form to multiple clients in bulk./tenants/{tenant}/data-forms/{code}/send-bulk
-
POST Convert Form FileConverts an external form definition file (e.g. Engager .cexp) into Sodium's import format./tenants/{tenant}/data-forms/convert
-
GET Preview DataFormReturns the form structure as the client would see it, for preview purposes./tenants/{tenant}/data-forms/{code}/preview