Forms

Update a form submission by token

Updates a form submission for a given form by token.

patch/api/forms/{formId}/submissions/by-token/{submissionToken}

Path parameters

formIdinteger required

submissionTokenstring required

The token of the submission that will be updated

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

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 3 of the 7 revisions of this API.51514

Feb 6, 2026a9990632322311See 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
Nov 21, 202550eff5014b78376See 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
- ▲
  media type application/problem+json was changed to a more general media type application/json for the response status 400
  response-media-type-name-generalized
- ●
  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 optional property errors from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property message from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property statusCode from the response with the 400 status
  response-optional-property-removed
- ○
  added the optional property allOf[SubmissionModel]/submittedBy to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property detail to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property instance to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property title to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property type to the response with the 400 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
Mar 24, 2025fbc3fe6ecbf1178See the full diff
- ▲
  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 200 status
  response-optional-property-removed
- ●
  removed the optional property detail from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property instance from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 400 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 jsonData
  new-optional-request-property
- ○
  added the new optional request property metadata
  new-optional-request-property
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 400
  response-media-type-name-specialized
- ○
  added the optional property errors to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property statusCode to the response with the 400 status
  response-optional-property-added
This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history