Add a custom tab to a deal
/deals/{deal_id}/custom-tabsAdds a custom tab to the deal and returns it with a Location. body is sanitised as HTML on write and can be up to 1,000,000 characters. The tab is added at the end of the deal's tabs so investors see it, and a published deal accepts it. dry_run shows the result without saving it. Emits deal_custom_tab.created and sends no email. DELETE /deals/{deal_id}/custom-tabs/{id} undoes it.
Path parameters
The deal's id, a uuid. An unknown deal, or one the token can't see, returns 404.
Query parameters
Validate and run the call without committing it, returning what the real call would return with
meta.dry_runset.
Headers
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.
Request body
application/json, required · DealCustomTabCreate
The tab title.
The tab content as HTML. It is sanitised on write.
A short description of the tab.
Whether investors see a read more link instead of the whole body. Defaults to true.
Whether investors see an estimated reading time. Defaults to true.
{
"title": "Market",
"body": "<p>A large and growing market.</p>"
}Responses
{
"data": {
"id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
"title": "string",
"body": "string",
"description": "string",
"show_read_more": true,
"show_reading_time": true,
"created_at": "2026-06-12T10:00:00+00:00",
"updated_at": "2026-06-12T10:00:00+00:00"
}
}Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per
problem, or a code documented on the operation.
Examples
curl -X POST https://your-org-domain/kong/core/api/v2/deals/{deal_id}/custom-tabs\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"\
-d '{
"title": "Market",
"body": "<p>A large and growing market.</p>"
}'