Investor Preferences

Replace the classifications of an investor preference

PUT/investor-preferences/{id}/classifications
investor-preferences:writereplace_investor_preference_classificationsDestructiveIdempotent

Makes the ids you send the preference's classifications and returns the set. Only classifications of your organisation are replaced; ids that belong to other organisations stay as they are. Up to 500 distinct ids; [] clears your organisation's. An id that is no classification of yours returns 422 exists naming the entry (ids.N). Emits investor_preference.updated (classifications) when it changed; sends no email. Sending the old ids 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.

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

  • idsinteger[]Required#

    Every classification the investor should hold by hand, at most 500 distinct ids. Send an empty list to clear them.

{
  "ids": [
    12,
    14
  ]
}

Responses

200

The classifications of the preference.

InvestorPreferenceClassification[]
{
  "data": [
    {
      "id": 1,
      "label": "string"
    }
  ]
}
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 PUT https://your-org-domain/kong/core/api/v2/investor-preferences/{id}/classifications\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "ids": [
    12,
    14
  ]
}'