Forms

Complete a submission

POST/submissions/{submissionId}/complete
forms:writecomplete_submission_legacyDeprecatedSunset 2027-06-30

Finalises a draft submission (draft -> completed): runs every field's validator (including required checks) and stamps the completion time. Validation failures return 422 keyed by field uuid; a form that forbids completion returns 422 form_not_completable. A repeat answers 200 and sends nothing. Deprecated: withdrawn on 2027-06-30. POST /submissions/{id}/actions/complete replaces it; the Link header names it.

Path parameters

  • submissionIdstring (uuid)Required#

    The submission's public uuid.

Responses

200

OK

FormSubmission
{
  "data": {
    "id": "7d8e9f01-2a3b-4c5d-9e6f-708192a3b4c5",
    "form_id": "c3d4e5f6-0718-4293-a4b5-c6d7e8f90112",
    "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "status": "completed",
    "started_at": "2026-06-15T10:30:00+00:00",
    "completed_at": "2026-06-15T10:35:00+00:00",
    "answers": {
      "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9": "Ada Lovelace"
    },
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-15T10:35:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/submissions/{submissionId}/complete\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"