Skip to main content
PATCH
Update a member's notification settings
Beta Disclaimer: This beta endpoint is evolving; the API contract may change.

Sets the notification settings an organization member has explicitly chosen. Each rule names notification types, resources and channels, and applies one effect to every combination of them. A notification type no rule names keeps the setting it had, so this endpoint never has to carry a member’s whole configuration. Three effects: ‘enabled’ and ‘disabled’ store an explicit choice, and ‘inherit’ removes the stored setting so the notification follows the platform default again. Sending the same body twice changes nothing the second time. The request either applies completely or changes nothing: a rule naming a notification type that does not exist, that the member cannot configure, or a resource the caller cannot access is rejected whole, as is a request that names the same type, resource and channel twice. A request carries at most 100 rules, addressing at most 1000 settings in total.

Permission

The API key must have the control-plane:organization:manage-notification-settings permission.

Authorizations

Authorization
string
header
required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId
string<uuid>
required

ID of the organization the member belongs to.

userId
string<uuid>
required

ID of the member whose settings are updated.

Body

application/json
rules
object[]
required

Rules to apply. Every rule is applied, in the order given.

Required array length: 1 - 100 elements

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object