Responses

Submit response

Finalizes a response by changing its status to 'completed'. Requires ownership of response.

post/forms/{formId}/responses/{responseId}/submit

Request body

saveboolean required

Response

Response submitted successfully.

idstring required
formstring ulid required
respondentstring ulid nullable
status'draft' | 'completed' | 'edited' required
startedstring date-time required
submittedstring date-time nullable
editedstring date-time nullable

Changes

Changed in 4 of the 14 revisions of this API.244

    • added required request body

      request-body-added-required

    • added the optional property edited to the response with the 200 status

      response-optional-property-added

  • de597e8f26bc21See the full diff
    • added the new draft enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new edited enum value to the status response property for the response status 200

      response-property-enum-value-added

    • removed the in_progress enum value from the status response property for the response status 200

      response-property-enum-value-removed

  • 0d7f3c750979122See the full diff
    • removed the request body

      request-body-removed

    • removed the optional property edited from the response with the 200 status

      response-optional-property-removed

    • added the new in_progress enum value to the status response property for the response status 200

      response-property-enum-value-added

    • removed the draft enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the edited enum value from the status response property for the response status 200

      response-property-enum-value-removed

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