Data Form - Requests

Form requests sent to clients. View submissions and review individual answers (accept or reject per field). Accepted answers apply the submitted value to the client record. Supports auto-accept for forms configured to skip manual review.

OpenAPI Spec

Guides Operations Schemas

GET List DataFormRequests
Lists all DataFormRequests for the given tenant.
/tenants/{tenant}/data-form-requests
GET Get DataFormRequest
Gets a DataFormRequest for the specified tenant.
/tenants/{tenant}/data-form-requests/{code}
PUT Update DataFormRequest
Updates a DataFormRequest for the specified tenant.
/tenants/{tenant}/data-form-requests/{code}
DELETE Delete DataFormRequest
Deletes a DataFormRequest for the specified tenant.
/tenants/{tenant}/data-form-requests/{code}
PUT Review DataForm Answer
Accepts or rejects a single answer on a submitted form request. When accepted, applies the value to the client record.
/tenants/{tenant}/data-form-requests/{code}/answers/{questionCode}/review
PUT Resend DataForm Request
Resends the notification email for a pending form request to the specified recipients. Everyone the form already went to keeps their link and keeps be...
/tenants/{tenant}/data-form-requests/{code}/resend
PUT Cancel DataForm Request
Cancels a form request still awaiting the client's response. It stops being chased, leaves the client's outstanding forms and its links stop working. ...
/tenants/{tenant}/data-form-requests/{code}/cancel
GET Get DataForm Request Recipients
Returns the email addresses a form request currently counts as its recipients: everyone it was sent to and has not since been withdrawn from. These ar...
/tenants/{tenant}/data-form-requests/{code}/recipients
PUT Reopen DataForm Request
Sends a submitted form request back to the client to complete again. Reuses the same request rather than creating a new one: the previous answers pre-...
/tenants/{tenant}/data-form-requests/{code}/reopen