Investor Preferences

Update an investor preference

PATCH/investor-preferences/{id}
investor-preferences:writeupdate_investor_preferenceIdempotent

Changes state (enabled or disabled), enforcement_type or editable and returns the preference. The changes are applied together or not at all. A body that changes nothing returns the preference unchanged and emits nothing. name and form_id are read-only, and classifications change through /investor-preferences/{id}/classifications. dry_run shows the result without saving it. Emits investor_preference.updated; no email. Sending the previous values undoes it.

Path parameters

  • idstring (uuid)Required#

    The record's id.

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 · InvestorPreferenceUpdate

  • statestring#

    enabled asks investors the preference; disabled stops asking.

    One of: enabled, disabled
  • enforcement_typestring#

    none leaves the preference optional, popup shows investors a prompt, forced requires an answer.

    One of: none, popup, forced
  • editableboolean#

    Whether investors can change their answers after giving them.

{
  "state": "enabled",
  "enforcement_type": "popup"
}

Responses

200

The updated preference.

InvestorPreference
{
  "data": {
    "id": "4f7c1d2e-8a3b-4c5d-9e6f-0a1b2c3d4e5f",
    "name": "Quarterly updates",
    "form_id": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "state": "enabled",
    "enforcement_type": "popup",
    "editable": true,
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-15T10:30: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
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/investor-preferences/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "state": "enabled",
  "enforcement_type": "popup"
}'