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.

OpenAPI Spec

Guides Operations Schemas

GET List DataForms
Lists all DataForms for the given tenant. Requires: ViewAll on DataForms.
/tenants/{tenant}/data-forms
POST Create DataForm
Creates a new DataForm for the specified tenant. Requires: Create on DataForms.
/tenants/{tenant}/data-forms
GET Get DataForm
Gets a DataForm for the specified tenant. Requires: ViewAll on DataForms.
/tenants/{tenant}/data-forms/{code}
PUT Update DataForm
Updates a DataForm for the specified tenant. Requires: Update on DataForms.
/tenants/{tenant}/data-forms/{code}
DELETE Delete DataForm
Deletes a DataForm for the specified tenant. Requires: Delete on DataForms.
/tenants/{tenant}/data-forms/{code}
GET List Library DataForms
List all DataForms available in the library as templates. Use optional 'search' query parameter to filter by Code, Name, or Description. Requires: Vi...
/tenants/{tenant}/data-forms/library
GET Get Library DataForm
Get details of a specific DataForm template from the library Requires: ViewAll on DataForms.
/tenants/{tenant}/data-forms/library/{code}
PUT Revert DataForm to Library
Reverts 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 Library
Creates 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 Client
Sends a published form to a single client, creating a form request and sending a notification email. When scheduledAt is set, nothing is created now: ...
/tenants/{tenant}/data-forms/{code}/send
POST Send DataForm to Multiple Clients
Sends a published form to multiple clients in bulk. When scheduledAt is set, nothing is created now: a scheduled send dispatches it at that time and 2...
/tenants/{tenant}/data-forms/{code}/send-bulk
POST Convert Form File
Converts an external form definition file (e.g. Engager .cexp) into Sodium's import format. Requires: Create on DataForms.
/tenants/{tenant}/data-forms/convert
POST Create Client Preview Link
Creates a short-lived (5 min) portal URL for staff to preview the form exactly as a specific client would see it. Access is gated by client visibility...
/tenants/{tenant}/data-forms/{code}/client-preview
GET Preview DataForm
Returns the form structure as the client would see it, for preview purposes. Requires: ViewAll on DataForms.
/tenants/{tenant}/data-forms/{code}/preview