Sign in
Forms

Create a new submission

Creates a new form submission

post/api/forms/{formId}/submissions

Path parameters

formIdinteger required

The ID of the form for which the submission is made.

Request body

isCompleteboolean nullable

Boolean flag to indicate if a submission is complete. Optional

currentPageinteger nullable

Current page if the form has multiple pages. Optional

jsonDatastring nullable

Stringified form submission data

metadatastring nullable

Stringified metadata related to the form submission

reCaptchaTokenstring nullable

reCAPTCHA v3 token for bot protection

Response

Created

idstring
isCompleteboolean
jsonDatastring
formIdstring
formDefinitionIdstring
currentPageinteger nullable
metadatastring nullable
tokenstring nullable
completedAtstring date-time nullable
createdAtstring date-time
modifiedAtstring date-time nullable
statusstring
submittedBystring nullable

Changes

Changed in 3 of the 7 revisions of this API.576

  • a9990632322311See the full diff
    • ▲

      added BasePublicSubmissionRequest to the request body allOf list

      request-body-all-of-added

    • ●

      removed BaseSubmissionRequest from the request body allOf list

      request-body-all-of-removed

  • 50eff5014b78242See the full diff
    • ▲

      added BaseSubmissionRequest subschema #2 to the request body allOf list

      request-body-all-of-added

    • ▲

      the request's body type/format changed from object/ to /

      request-body-type-changed

    • ●

      removed the request property currentPage

      request-property-removed

    • ●

      removed the request property isComplete

      request-property-removed

    • ●

      removed the request property jsonData

      request-property-removed

    • ●

      removed the request property metadata

      request-property-removed

    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      added the optional property allOf[SubmissionModel]/submittedBy to the response with the 201 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fbc3fe6ecbf1224See the full diff
    • ▲

      added the new required request property jsonData

      new-required-request-property

    • ▲

      the request's body type/format changed from / to object/

      request-body-type-changed

    • ●

      removed BasePublicSubmissionRequest subschema #2 from the request body allOf list

      request-body-all-of-removed

    • ●

      removed the optional property allOf[SubmissionModel]/submittedBy from the response with the 201 status

      response-optional-property-removed

    • ○

      added the new optional request property currentPage

      new-optional-request-property

    • ○

      added the new optional request property isComplete

      new-optional-request-property

    • ○

      added the new optional request property metadata

      new-optional-request-property

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog