Investor Preferences

Mark an investor preference saved for yourself

POST/investor-preferences/{id}/actions/mark-saved

Records that you, the person who owns the token, saved your answer to the preference, and returns the preference. It writes only your own answer state and never another person's, so it needs a personal token: a token for an integration answers 403 forbidden. It works on a disabled preference too, and repeating it changes nothing. The preference itself is unchanged. dry_run shows the result without saving it. Emits no event; no email. Has no undo.

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.

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.

Responses

200

The preference, with your saved answer recorded.

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
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/investor-preferences/{id}/actions/mark-saved\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"