Investor Preferences

Add a classification to an investor preference

POST/investor-preferences/{id}/classifications
investor-preferences:writeadd_investor_preference_classificationsIdempotent

Adds one classification to the preference and returns the set. One already in the set changes nothing. An id that is no classification of yours returns 422 exists. Emits investor_preference.updated with classifications as the changed field when it changed; sends no email. DELETE /investor-preferences/{id}/classifications/{member_id} 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 · InvestorClassificationInput

  • idintegerRequired#

    The classification, from GET /classifications.

{
  "id": 12
}

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 POST https://your-org-domain/kong/core/api/v2/investor-preferences/{id}/classifications\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "id": 12
}'