Exclude an investor or team from a deal
/deals/{id}/exclusionsHides the deal from one investor or team and returns the set. The id must be an investor you can see or a team, else 422 exists. One already excluded changes nothing; one the deal shows flips to hidden. Outside draft, awaiting approval and ready to publish it returns 409 invalid_state; organisation.enable_classifications_changes_on_published_deals also allows published deals (a client organisation uses its parent's). Emits deal.updated (exclusions); no email. Folder access follows after the call returns. DELETE on the member undoes it.
Path parameters
The record's id.
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 · DealExclusionInput
The investor or the team.
{
"id": "9c4b1d2e-3f5a-4b6c-8d7e-0f1a2b3c4d5e"
}Responses
{
"data": [
{
"id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
"entity": "user"
}
]
}Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
The request conflicts with existing state (error.code = conflict),
e.g. a compliance flow with the requested name already exists.
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/{id}/exclusions\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"\
-d '{
"id": "9c4b1d2e-3f5a-4b6c-8d7e-0f1a2b3c4d5e"
}'