Responses

Start response

Initiates a new response session for the form. Requires RESPOND permission.

post/forms/{formId}/responses

Response

Response session created.

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

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

      response-optional-property-added

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

      response-property-enum-value-added

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

      response-property-enum-value-added

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

      response-property-enum-value-removed

  • 0d7f3c75097922See the full diff
    • removed the optional property edited from the response with the 201 status

      response-optional-property-removed

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

      response-property-enum-value-added

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

      response-property-enum-value-removed

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

      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