User Data Capture

Update a data capture form

PATCH/data-capture-forms/{id}
user-data-capture:writeupdate_data_capture_formIdempotent

Changes what you send and returns the form. pages and fields are upserted by id or, for fields, reference; delete_field_ids takes field ids or references and delete_page_ids page ids. Every id must belong to this form, else 422 exists. status moves the form between enabled, internal_only and disabled: any move is allowed and the same value changes nothing. dry_run shows the result without saving it. Emits data_capture_form.updated when something changes and sends no email. Sending the old values undoes it.

Path parameters

  • idstring (uuid)Required#

    The data capture form's id, a uuid. An unknown or deleted id returns 404.

Query parameters

  • dry_runboolean#

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

Request body

application/json, required · DataCaptureFormUpdate

  • namestring#

    The form's display name.

  • statusstring#

    Move the form to this status. enabled asks every user for the form's fields, internal_only asks internal users only, and disabled asks nobody. The status it already has changes nothing.

    One of: enabled, disabled, internal_only
  • pagesarray | null#

    Pages to add or change.

  • fieldsarray | null#

    Fields to add or change.

  • delete_field_idsarray | null#

    Fields to remove, each by id or reference.

  • delete_page_idsarray | null#

    Pages to remove, each by id.

{
  "name": "UK Investor Profile v2",
  "status": "internal_only",
  "delete_field_ids": [
    "national_insurance_number"
  ]
}

Responses

200

The updated data capture form.

DataCaptureForm
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "status": "enabled",
    "field_count": 1,
    "pages": [
      {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "name": "string",
        "description": "string",
        "order": 1
      }
    ],
    "fields": [
      {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "label": "string",
        "name": "string",
        "description": "string",
        "type": "string",
        "reference": "string",
        "validator": "string",
        "placeholder": "string",
        "pre_population_key": "string",
        "backfill": true,
        "order": 1,
        "page_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "option_preset_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "options": [],
        "required": true,
        "conditions": [],
        "condition_logic": "AND"
      }
    ],
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00: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
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

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 PATCH https://your-org-domain/kong/core/api/v2/data-capture-forms/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "UK Investor Profile v2",
  "status": "internal_only",
  "delete_field_ids": [
    "national_insurance_number"
  ]
}'