Creates a new submission and queue documents for generation

post

https://{server}/v1/clients/Submissions

Accepts submission details in the request body, creates a new submission, and queues documents for generation.
Returns the unique identifier of the created submission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request body to create submission.

Represents a request to create a submission.

name

string

required

length between 1 and 200

A display name for the submission. Max 200 characters.

formId

int32

required

1 to 2147483647

The ID of the form to submit. Retrieve form IDs from the Forms API.

userEmailAddress

string | null

Email address of the submitting user.

groupIds

array of int32s | null

IDs of groups granted access to view this submission. If omitted, access defaults to the submitting user only.

groupIds

iManageFolderPath

string | null

The iManage folder path where the generated documents will be uploaded to. e.g. 'libraries/DEV/folders/DEV!171/documents'

submissionLocalTime

date-time | null

The submitter's local date and time including UTC offset (e.g. '2024-06-15T09:30:00+10:00'). Used to evaluate date/time expressions relative to the user's timezone.

answers

array of objects | null

The list of field answers for the submission. Each entry corresponds to a field defined on the form.

answers

isTest

boolean

When true, the submission is treated as a test run. Generated documents are marked accordingly and excluded from production reporting.

isDraft

boolean

When true, the submission is saved as a draft and documents are not generated. The submission can be completed at a later time.

externalMatterId

string | null

The ID of the matter in the external practice management system. Use in conjunction with IntegrationSource and UploadDocumentsToMatter.

integrationSource

string | null

The practice management system associated with ExternalMatterId. Supported values: "clio", "leap", "actionstep", "smokeball", "unity", or a custom source API identifier.

uploadDocumentsToMatter

boolean

When true, generated documents are uploaded to the matter specified by ExternalMatterId and IntegrationSource.

netDocumentsDestination

string | null

The NetDocuments workspace or folder ID to upload generated documents to (e.g. '3462-8536-1690'). Obtain this ID from your NetDocuments environment.

externalId

string | null

A unique identifier from your system (max 200 characters). Returned in webhook payloads on document generation and can also be used to query submissions.

saveIdentifiedRecords

boolean

When true, entity records resolved from answers are persisted against the submission.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200OK

400Bad Request

404Not Found