Deal Tranches

Delete a tranche of a deal

DELETE/deals/{deal_id}/tranches/{id}
tranches:writedelete_deal_trancheDestructiveIdempotent

Deletes the tranche for good and returns 204. It can't be undone and has no dry run; add the tranche again with POST /deals/{deal_id}/tranches. A repeat call returns 404. Emits deal_tranche.deleted and sends no email. Three cases are refused with 409 and change nothing. invalid_state means the tranche is the deal's active tranche (make another one active with PATCH /deals/{id} first), or the deal's last tranche (a deal keeps at least one). conflict means an investment that has not been deleted still sits in the tranche. Investments that were deleted, and form completions recorded against the tranche, are kept as history.

Path parameters

  • deal_idstring (uuid)Required#

    The deal's id, a uuid. An unknown deal, or one the token can't see, returns 404.

  • idstring (uuid)Required#

    The tranche's id.

Responses

204

The tranche 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
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

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/deals/{deal_id}/tranches/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"