Deal Tranches

Rename a tranche of a deal

PATCH/deals/{deal_id}/tranches/{id}
tranches:writeupdate_deal_trancheIdempotent

Changes the fields you send and returns the tranche. Only name can change; is_active is read-only. dry_run shows the result without saving it. Emits deal_tranche.updated, only when the name really changes, and sends no email. Sending the previous name undoes it.

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.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · DealTrancheUpdate

  • namestring#

    The tranche's display name.

{
  "name": "Series B - Tranche 2"
}

Responses

200

The updated tranche.

DealTranche
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "is_active": true,
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
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 PATCH https://your-org-domain/kong/core/api/v2/deals/{deal_id}/tranches/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Series B - Tranche 2"
}'