User Data Capture

Set a User Data Capture form's enablement state

PATCH/user-data-capture/forms/{formId}/status
user-data-capture:writeset_user_data_capture_form_state_legacyDeprecatedSunset 2027-06-30

Sets the form's state with a display string: Enabled, Disabled or Enabled for Internal Users. A request for the state the form already has answers 200 and changes nothing. Deprecated: withdrawn on 2027-06-30. PATCH /data-capture-forms/{id} replaces it; the Link header names it.

Path parameters

  • formIdstring (uuid)Required#

    The user-data-capture form's public uuid.

Request body

application/json, required · UserDataCaptureFormStateUpdate

  • statusstringRequired#
    One of: Enabled, Disabled, Enabled for Internal Users
{
  "status": "Enabled"
}

Responses

200

OK

UserDataCaptureForm
{
  "data": {
    "id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "name": "KYC profile",
    "status": "Enabled for Internal Users",
    "field_count": 2,
    "fields": [
      {
        "reference": "tax_residency",
        "label": "Tax residency",
        "name": "tax_residency",
        "type": "TEXT",
        "allowed_values": null,
        "required": true
      },
      {
        "reference": "investor_category",
        "label": "Investor category",
        "name": "investor_category",
        "type": "DROPDOWN",
        "allowed_values": [
          "retail",
          "professional"
        ],
        "required": false
      }
    ],
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-21T09:15:02+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 PATCH https://your-org-domain/kong/core/api/v2/user-data-capture/forms/{formId}/status\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "status": "Enabled"
}'