Investments

Delete an investment

DELETE/investments/{id}
transactions:writedelete_investmentDestructiveIdempotent

Removes the investor from this tranche of the deal and returns 204, as POST /investments/{id}/actions/remove does without a reason. Every live journey event of the investor in the tranche is deleted, step triggers are undone, forms cleared and generated documents superseded. When no other tranche of the investor has events, their access to the deal's step folders is revoked. Emits investment.deleted, notifies connected systems and staff, and audits. Can't be undone; has no dry run. To change one event, use PATCH or DELETE /journey-events/{id}.

Path parameters

  • idstring (uuid)Required#

    The record's id.

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

204

The investment was deleted.

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 DELETE https://your-org-domain/kong/core/api/v2/investments/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"