Set an investor's status

Sets the user's lifecycle status.

• active: re-enables a suspended user and clears disabled_email_sent.
• suspended: disables the user. notify (none default, email, password) controls the account-disabled email; remove_distribution removes the user from every distribution list. Both are only accepted with suspended.
• deactivated: sets the user's status to deactivated, which an active can reverse. The response is { "deactivated": true } rather than the user.

notify and remove_distribution must be omitted entirely (not sent as null or false) unless status is suspended, else 422.

Deprecated: withdrawn on 2027-06-30. POST /investors/{id}/actions/activate replaces it for active, POST /investors/{id}/actions/suspend for suspended and DELETE /investors/{id} for deactivated; every answer carries a Link header with rel="successor-version". This route keeps its old body and answer. Like the actions it moves an investor from any status to any other.

{
  "status": "suspended",
  "notify": "email"
}

{
  "data": {
    "id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "email": "ada.lovelace@example.com",
    "type": "investor",
    "status": "suspended",
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-18T16:20:00+00:00"
  }
}

curl -X PATCH https://your-org-domain/kong/core/api/v2/investors/{userId}/status\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "status": "suspended",
  "notify": "email"
}'