--- title: "Update a User Notification" method: PATCH path: "/notifications/v1/user-notifications/{id}" tags: ["User Notifications (notifications/v1)"] --- # Update a User Notification `PATCH /notifications/v1/user-notifications/{id}` [![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To User Notifications API v1](https://img.shields.io/badge/-Request%20Access%20To%20User%20Notifications%20API%20v1-%23bc8540)](mailto:ccloud-api-access+notifications-v1-early-access@confluent.io?subject=Request%20to%20join%20notifications/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20notifications/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.) Make a request to update a user notification. ## Path parameters - `id` string, required ## Request body - NotificationsV1UserNotification — `UserNotification` objects represent in-app notifications scoped to a specific Confluent Cloud user. Each notification carries a severity, references the Confluent Cloud resource it relates to, and tracks whether the user has read it. This API lets you list and retrieve your notifications, mark notifications as read or unread, and fetch an unread-count summary. `read` is the only mutable field on this resource; `PATCH` requests with values for other fields will have those values silently ignored. Two `PATCH` shapes are supported: - `PATCH /user-notifications/{id}` — update a single notification by id. - `PATCH /user-notifications` — update the read state of every notification matching the supplied filter query parameters. The body is a narrow payload (`{ "read": true | false }`) and the same filters accepted by the list endpoint scope which notifications are updated (with the exception of `include`, which is a list-only partial-response selector). The heavier `integrations` and `recommended_actions` fields are populated on single-resource reads (`GET /user-notifications/{id}`) and omitted from list responses by default to keep collection payloads slim. Use the `include` query parameter on the list endpoint to opt in to populating these fields (`?include=integrations,recommended_actions`). Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). ## The User Notifications Model - `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. - `id` string — 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"). - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `read` boolean — Whether the notification has been read by the user. - `read_at` string, date-time, nullable — The time the notification was marked as read, or `null` if it is unread. - `severity` string — 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_at` string, date-time — The time the underlying event was generated. - `resource` NotificationsV1ResourceSnapshot — Point-in-time snapshot of the Confluent Cloud resource a `UserNotification` relates to. Captured at delivery; values remain stable even if the underlying resource is later renamed or deleted. - `type` string, required — The type of Confluent Cloud resource this notification relates to. - `crn` string, required — CRN of the Confluent Cloud resource at delivery time. - `display_name` string, required — Human-readable name of the resource captured at notification time. Does not update if the underlying resource is later renamed. - `actions` NotificationsV1NotificationAction[] — Ordered list of user-facing actions associated with this notification. The first entry is the primary action (`role: PRIMARY`) and is always present; subsequent entries are secondary. Cardinality is open-ended — additional actions may be added over time without a breaking schema change. - `identifier` string, required — Stable identifier for the action, suitable for analytics. Stable across notification deliveries that recommend the same action. - `url` string, uri, required — Confluent Cloud URL this action navigates to. - `role` string, required — Visual prominence of the action. `PRIMARY` is the recommended default action; `SECONDARY` is shown alongside as a less prominent option. - `notification_type` NotificationsV1NotificationType — The type of notifications (and their corresponding metadata) supported by Confluent. Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). ## The Notification Types Model - `api_version` 'notifications/v1' — APIVersion defines the schema version of this representation of a resource. - `kind` 'NotificationType' — Kind defines the object this REST resource represents. - `id` string — 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"). - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `display_name` string — Human readable display name of the notification type - `category` string — Represents the group with which the notification is associated. Notifications are grouped under certain categories for better organization. - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are grouped here. - ACCOUNT: All Confluent account related notifications are grouped here. For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. - `description` string — Human readable description of the notification type - `subscription_priority` string — Indicates whether the notification is auto-subscribed and if the user can opt-out. - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. - `is_included_in_plan` boolean — Whether this notification is available to subscribe or not as per the user's current billing plan. - `severity` string — Severity indicates the impact of this 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. - `resource_type` string — The type of resource this notification is associated with. Optional field. - `integrations` NotificationsV1Integration[] — The integrations this notification was delivered to. Each entry is a point-in-time snapshot of the integration at delivery time, so values remain accurate even if the underlying `Integration` is later modified or deleted. Populated on single-resource reads (`GET /user-notifications/{id}`); omitted from list responses. - `api_version` 'notifications/v1' — APIVersion defines the schema version of this representation of a resource. - `kind` 'Integration' — Kind defines the object this REST resource represents. - `id` string — 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"). - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `display_name` string — A human readable name for the particular integration - `description` string — A human readable description for the particular integration - `target` union — Target for the particular integration - NotificationsV1SlackTarget — Target required for Slack integration - `kind` 'Slack', required — Integration Type - `webhook_url` string, uri, required — Slack Webhook URL for the particular Slack channel - NotificationsV1RoleEmailTarget — Email integration target to send email to all user with specified role - `kind` 'RoleEmail', required — Email Integration type for Role - `role_name` string, required — name of the role - NotificationsV1UserEmailTarget — Email integration target to send email to a particular user - `kind` 'UserEmail', required — Email Integration type for User - `user` GlobalObjectReference, required — ObjectReference provides information for you to locate the referred object - `id` string, required — ID of the referred resource - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - NotificationsV1WebhookTarget — Target required for webhook integration - `kind` 'Webhook', required — Integration Type - `url` string, uri, required — URL endpoint for the webhook - NotificationsV1MsTeamsTarget — Target required for MS Teams integration - `kind` 'MsTeams', required — Integration Type - `webhook_url` string, uri, required — MS Teams Webhook URL for the particular team channel - NotificationsV1InAppTarget — Per-user in-app notification target; lazy-onboarded on first read. - `kind` 'InApp', required — Integration Type - `user` GlobalObjectReference, required — ObjectReference provides information for you to locate the referred object - `id` string, required — ID of the referred resource - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - `recommended_actions` NotificationsV1RecommendedActions — Versioned payload describing the recommended actions a user can take in response to a `UserNotification`. The shape is stable per `version` and consumers should branch on `version` when deserializing. - `version` integer, required — Schema version of the `recommended_actions` payload. Increment when the payload shape changes in a non-backward-compatible way. - `content` string, required — Human-readable body text describing the recommended actions. Rendered as Markdown for `version: 1`. ## Response `200` User Notification. - object — `UserNotification` objects represent in-app notifications scoped to a specific Confluent Cloud user. Each notification carries a severity, references the Confluent Cloud resource it relates to, and tracks whether the user has read it. This API lets you list and retrieve your notifications, mark notifications as read or unread, and fetch an unread-count summary. `read` is the only mutable field on this resource; `PATCH` requests with values for other fields will have those values silently ignored. Two `PATCH` shapes are supported: - `PATCH /user-notifications/{id}` — update a single notification by id. - `PATCH /user-notifications` — update the read state of every notification matching the supplied filter query parameters. The body is a narrow payload (`{ "read": true | false }`) and the same filters accepted by the list endpoint scope which notifications are updated (with the exception of `include`, which is a list-only partial-response selector). The heavier `integrations` and `recommended_actions` fields are populated on single-resource reads (`GET /user-notifications/{id}`) and omitted from list responses by default to keep collection payloads slim. Use the `include` query parameter on the list endpoint to opt in to populating these fields (`?include=integrations,recommended_actions`). Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). ## The User Notifications Model - `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. - `id` string, 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"). - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `read` boolean, required — Whether the notification has been read by the user. - `read_at` string, date-time, nullable — The time the notification was marked as read, or `null` if it is unread. - `severity` string — 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_at` string, date-time, required — The time the underlying event was generated. - `resource` NotificationsV1ResourceSnapshot, required — Point-in-time snapshot of the Confluent Cloud resource a `UserNotification` relates to. Captured at delivery; values remain stable even if the underlying resource is later renamed or deleted. - `type` string, required — The type of Confluent Cloud resource this notification relates to. - `crn` string, required — CRN of the Confluent Cloud resource at delivery time. - `display_name` string, required — Human-readable name of the resource captured at notification time. Does not update if the underlying resource is later renamed. - `actions` NotificationsV1NotificationAction[], required — Ordered list of user-facing actions associated with this notification. The first entry is the primary action (`role: PRIMARY`) and is always present; subsequent entries are secondary. Cardinality is open-ended — additional actions may be added over time without a breaking schema change. - `identifier` string, required — Stable identifier for the action, suitable for analytics. Stable across notification deliveries that recommend the same action. - `url` string, uri, required — Confluent Cloud URL this action navigates to. - `role` string, required — Visual prominence of the action. `PRIMARY` is the recommended default action; `SECONDARY` is shown alongside as a less prominent option. - `notification_type` NotificationsV1NotificationType, required — The type of notifications (and their corresponding metadata) supported by Confluent. Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). ## The Notification Types Model - `api_version` 'notifications/v1' — APIVersion defines the schema version of this representation of a resource. - `kind` 'NotificationType' — Kind defines the object this REST resource represents. - `id` string — 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"). - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `display_name` string — Human readable display name of the notification type - `category` string — Represents the group with which the notification is associated. Notifications are grouped under certain categories for better organization. - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are grouped here. - ACCOUNT: All Confluent account related notifications are grouped here. For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. - `description` string — Human readable description of the notification type - `subscription_priority` string — Indicates whether the notification is auto-subscribed and if the user can opt-out. - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. - `is_included_in_plan` boolean — Whether this notification is available to subscribe or not as per the user's current billing plan. - `severity` string — Severity indicates the impact of this 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. - `resource_type` string — The type of resource this notification is associated with. Optional field. - `integrations` NotificationsV1Integration[] — The integrations this notification was delivered to. Each entry is a point-in-time snapshot of the integration at delivery time, so values remain accurate even if the underlying `Integration` is later modified or deleted. Populated on single-resource reads (`GET /user-notifications/{id}`); omitted from list responses. - `api_version` 'notifications/v1' — APIVersion defines the schema version of this representation of a resource. - `kind` 'Integration' — Kind defines the object this REST resource represents. - `id` string — 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"). - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `display_name` string — A human readable name for the particular integration - `description` string — A human readable description for the particular integration - `target` union — Target for the particular integration - NotificationsV1SlackTarget — Target required for Slack integration - `kind` 'Slack', required — Integration Type - `webhook_url` string, uri, required — Slack Webhook URL for the particular Slack channel - NotificationsV1RoleEmailTarget — Email integration target to send email to all user with specified role - `kind` 'RoleEmail', required — Email Integration type for Role - `role_name` string, required — name of the role - NotificationsV1UserEmailTarget — Email integration target to send email to a particular user - `kind` 'UserEmail', required — Email Integration type for User - `user` GlobalObjectReference, required — ObjectReference provides information for you to locate the referred object - `id` string, required — ID of the referred resource - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - NotificationsV1WebhookTarget — Target required for webhook integration - `kind` 'Webhook', required — Integration Type - `url` string, uri, required — URL endpoint for the webhook - NotificationsV1MsTeamsTarget — Target required for MS Teams integration - `kind` 'MsTeams', required — Integration Type - `webhook_url` string, uri, required — MS Teams Webhook URL for the particular team channel - NotificationsV1InAppTarget — Per-user in-app notification target; lazy-onboarded on first read. - `kind` 'InApp', required — Integration Type - `user` GlobalObjectReference, required — ObjectReference provides information for you to locate the referred object - `id` string, required — ID of the referred resource - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - `recommended_actions` NotificationsV1RecommendedActions — Versioned payload describing the recommended actions a user can take in response to a `UserNotification`. The shape is stable per `version` and consumers should branch on `version` when deserializing. - `version` integer, required — Schema version of the `recommended_actions` payload. Increment when the payload shape changes in a non-backward-compatible way. - `content` string, required — Human-readable body text describing the recommended actions. Rendered as Markdown for `version: 1`. ## Other responses - `400` — Bad Request - `401` — The request lacks valid authentication credentials for this resource. - `403` — The access credentials were considered insufficient to grant access - `404` — Not Found - `409` — The request is in conflict with the current server state - `422` — Validation Failed - `429` — Rate Limit Exceeded - `500` — Oops, something went wrong! --- [API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)