Deals

Delete a tab

DELETE/deals/{dealId}/tabs/{tabKey}
deals:writedelete_deal_tabDestructiveIdempotentDeprecatedSunset 2027-06-30

Deletes a tab. By default disables the built-in content tab named by tabKey and removes it from the order (422 for an unknown key). ?custom=true instead soft-deletes the custom tab whose uuid is tabKey, scoped to the deal. Deprecated: it will be withdrawn on 2027-06-30. The tabs field of PATCH /deals/{id} replaces it, and /deals/{deal_id}/custom-tabs manages custom tabs; the Link header names the deal.

Path parameters

  • dealIdstring (uuid)Required#

    The deal's public uuid.

  • tabKeystringRequired#

    The content tab key (or a custom tab uuid when ?custom=true).

Query parameters

  • customboolean#

    Set to true to target a custom tab by uuid.

Responses

204

Deleted (no content).

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

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/deals/{dealId}/tabs/{tabKey}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"