Deals

Replace the visibility rules of a deal

PUT/deals/{id}/visibility
deal-visibility:writereplace_deal_visibilityDestructiveIdempotent

Makes the rules you send the only rules of the deal, of every entity kind, and returns them. Up to 1000, none repeated; [] clears all. Same 422 rules as adding. 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 (visibility) when they changed; no email. Folder access follows after the call returns. Sending the old rules undoes it.

Path parameters

  • idstring (uuid)Required#

    The record'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.

Headers

  • Idempotency-Keystring#

    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 · DealVisibilityReplace

  • itemsDealVisibilityInput[]Required#

    Every rule the deal should have, at most 1000, with no entity repeated. Send an empty list to clear them all.

{
  "items": [
    {
      "entity": "classification",
      "entity_id": "12",
      "included": true
    },
    {
      "entity": "user",
      "entity_id": "9c4b1d2e-3f5a-4b6c-8d7e-0f1a2b3c4d5e",
      "included": false
    }
  ]
}

Responses

200

Every visibility rule of the deal.

DealVisibility[]
{
  "data": [
    {
      "id": "string",
      "entity": "classification",
      "entity_id": "string",
      "included": true
    }
  ]
}
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 PUT https://your-org-domain/kong/core/api/v2/deals/{id}/visibility\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "items": [
    {
      "entity": "classification",
      "entity_id": "12",
      "included": true
    },
    {
      "entity": "user",
      "entity_id": "9c4b1d2e-3f5a-4b6c-8d7e-0f1a2b3c4d5e",
      "included": false
    }
  ]
}'