Forms

Create a submission

POST/submissions
forms:writecreate_submission

Starts a draft submission of a standard form for a user of your organisation and returns it with a Location. user_id is required for an organisation token and defaults to the token's own user for a personal token; it is data, not the actor. answers (field id to value) are saved without validation. Complete it with POST /submissions/{id}/actions/complete. Emits submission.created, sends no email and queues a profile backfill. DELETE /submissions/{id} undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · FormSubmissionCreate

  • form_idstring (uuid)Required#

    The form to answer. It must be a standard form that is not hidden.

  • user_idstring | null#

    The user the submission belongs to, from your organisation and not a service user. Required for an organisation token; a personal token defaults to its own user.

  • answersobject#

    Answers keyed by form field id. Saved as sent, with no validation until the submission is completed. A key that is not a field of the form is 422 exists.

{
  "form_id": "c3d4e5f6-0718-4293-a4b5-c6d7e8f90112",
  "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
  "answers": {
    "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9": "Ada Lovelace"
  }
}

Responses

201

The draft submission was created.

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:00Z",
    "completed_at": "2026-06-15T10:35:00Z",
    "answers": {
      "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9": "Ada Lovelace",
      "b2c3d4e5-f607-4182-93a4-b5c6d7e8f901": 250000
    },
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-15T10:35:00Z"
  }
}
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
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/submissions\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "form_id": "c3d4e5f6-0718-4293-a4b5-c6d7e8f90112",
  "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
  "answers": {
    "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9": "Ada Lovelace"
  }
}'