Sign in
User Notifications (notifications/v1)

Update a User Notification

Early Access Request Access To User Notifications API v1

Make a request to update a user notification.

patch/notifications/v1/user-notifications/{id}

Path parameters

idstring required

The unique identifier for the user notification.

Request body

api_version'notifications/v1'

APIVersion defines the schema version of this representation of a resource.

kind'UserNotification'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

readboolean

Whether the notification has been read by the user.

read_atstring date-time nullable

The time the notification was marked as read, or null if it is unread.

severitystring

The severity level of the notification.

  • CRITICAL: a high impact notification which needs immediate attention.
  • WARN: a warning notification which can be addressed now or later.
  • INFO: an informational notification.
received_atstring date-time

The time the underlying event was generated.

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/notifications/v1/user-notifications/un-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user-notification=un-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "read_at": "2026-01-31T11:00:00Z",
  "severity": "CRITICAL",
  "received_at": "2026-01-31T10:35:00Z",
  "resource": {
    "type": "CLUSTER",
    "crn": "crn://confluent.cloud/organization=org-abc/environment=env-xyz/kafka-cluster=lkc-ds23ad",
    "display_name": "prod-kafka-cluster"
  },
  "actions": [
    {
      "identifier": "manage_cluster_settings",
      "url": "https://confluent.cloud/environments/env-xyz/clusters/lkc-ds23ad/settings",
      "role": "PRIMARY"
    }
  ],
  "notification_type": {
    "id": "dlz-f3a90de",
    "metadata": {
      "self": "https://api.confluent.cloud/notifications/v1/notification-types/nt-12345",
      "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/notification-type=nt-12345",
      "created_at": "2006-01-02T15:04:05-07:00",
      "updated_at": "2006-01-02T15:04:05-07:00",
      "deleted_at": "2006-01-02T15:04:05-07:00"
    },
    "display_name": "Cluster Shrink",
    "category": "BILLING_LICENSING",
    "description": "Cluster shrink operation is completed",
    "subscription_priority": "REQUIRED",
    "severity": "INFO",
    "resource_type": "CONNECTOR"
  },
  "integrations": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/notifications/v1/integrations/i-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/integration=i-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "display_name": "Slack integration",
      "description": "A Slack channel integration",
      "target": {
        "kind": "Slack",
        "webhook_url": "https://hooks.slack.com/services/{id}/{id}/{id}"
      }
    }
  ],
  "recommended_actions": {
    "version": 1,
    "content": "Restart the cluster from the Confluent Cloud console."
  }
}

Response

User Notification.

api_version'notifications/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'UserNotification' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

readboolean required

Whether the notification has been read by the user.

read_atstring date-time nullable

The time the notification was marked as read, or null if it is unread.

severitystring

The severity level of the notification.

  • CRITICAL: a high impact notification which needs immediate attention.
  • WARN: a warning notification which can be addressed now or later.
  • INFO: an informational notification.
received_atstring date-time required

The time the underlying event was generated.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/notifications/v1/user-notifications/un-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/user-notification=un-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "read_at": "2026-01-31T11:00:00Z",
  "severity": "CRITICAL",
  "received_at": "2026-01-31T10:35:00Z",
  "resource": {
    "type": "CLUSTER",
    "crn": "crn://confluent.cloud/organization=org-abc/environment=env-xyz/kafka-cluster=lkc-ds23ad",
    "display_name": "prod-kafka-cluster"
  },
  "actions": [
    {
      "identifier": "manage_cluster_settings",
      "url": "https://confluent.cloud/environments/env-xyz/clusters/lkc-ds23ad/settings",
      "role": "PRIMARY"
    }
  ],
  "notification_type": {
    "id": "dlz-f3a90de",
    "metadata": {
      "self": "https://api.confluent.cloud/notifications/v1/notification-types/nt-12345",
      "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/notification-type=nt-12345",
      "created_at": "2006-01-02T15:04:05-07:00",
      "updated_at": "2006-01-02T15:04:05-07:00",
      "deleted_at": "2006-01-02T15:04:05-07:00"
    },
    "display_name": "Cluster Shrink",
    "category": "BILLING_LICENSING",
    "description": "Cluster shrink operation is completed",
    "subscription_priority": "REQUIRED",
    "severity": "INFO",
    "resource_type": "CONNECTOR"
  },
  "integrations": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/notifications/v1/integrations/i-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/integration=i-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "display_name": "Slack integration",
      "description": "A Slack channel integration",
      "target": {
        "kind": "Slack",
        "webhook_url": "https://hooks.slack.com/services/{id}/{id}/{id}"
      }
    }
  ],
  "recommended_actions": {
    "version": 1,
    "content": "Restart the cluster from the Confluent Cloud console."
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.