Sign in
Forms

Update a form submission

Updates a form submission for a given form.

patch/api/forms/{formId}/submissions/{submissionId}

Path parameters

formIdinteger required

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

submissionIdinteger required

The ID the submission that will be updated

Request body

jsonDatastring nullable

Stringified form submission data

isCompleteboolean nullable

Boolean flag to mark the form completion status

currentPageinteger nullable

The current page of the form

metadatastring nullable

Stringified metadata related to the form submission

Response

The form submission was updated successfully.

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 2 of the 7 revisions of this API.112

  • 50eff5014b7811See the full diff
    • ▲

      removed the media type application/problem+json for the response with the status 400

      response-media-type-removed

    • ○

      added the optional property allOf[SubmissionModel]/submittedBy to the response with the 200 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

  • fbc3fe6ecbf111See the full diff
    • ●

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

      response-optional-property-removed

    • ○

      added the media type application/problem+json for the response with the status 400

      response-media-type-added

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