---
title: "Update a Subscription"
method: PATCH
path: "/notifications/v1/subscriptions/{id}"
tags: ["Subscriptions (notifications/v1)"]
---
# Update a Subscription
`PATCH /notifications/v1/subscriptions/{id}`
[](#section/Versioning/API-Lifecycle-Policy)
Make a request to update a subscription.
## Path parameters
- `id` string, required
## Request body
- NotificationsV1Subscription — `Subscription` objects represent the intent of the customers to get notifications of particular types. A subscription is created for a particular `NotificationType` and the user will get notifications on the `Integrations` that are provided while creating the subscription. This API allows you to create, retrieve, and update subscriptions, as well as to view the list of all your subscriptions. You can also delete subscriptions with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). ## The Subscriptions Model
- `api_version` 'notifications/v1' — APIVersion defines the schema version of this representation of a resource.
- `kind` 'Subscription' — 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.
- `current_state` string — Denotes the state of the subscription. When the subscription is ENABLED, the user will receive notification on the configured Integrations. If the subscription is DISABLED, the user will not recieve any notification for the configured notification type. Note that, you cannot disable a subscription for `REQUIRED` notification type.
- `notification_type` GlobalObjectReference — 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
- `integrations` GlobalObjectReference[] — Integrations to which notifications are to be sent.
- `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
## Response `200`
Subscription.
- object — `Subscription` objects represent the intent of the customers to get notifications of particular types. A subscription is created for a particular `NotificationType` and the user will get notifications on the `Integrations` that are provided while creating the subscription. This API allows you to create, retrieve, and update subscriptions, as well as to view the list of all your subscriptions. You can also delete subscriptions with RECOMMENDED or OPTIONAL notification types. Subscriptions with REQUIRED notification types cannot be deleted. Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud). ## The Subscriptions Model
- `api_version` 'notifications/v1', required — APIVersion defines the schema version of this representation of a resource.
- `kind` 'Subscription', 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.
- `current_state` string — Denotes the state of the subscription. When the subscription is ENABLED, the user will receive notification on the configured Integrations. If the subscription is DISABLED, the user will not recieve any notification for the configured notification type. Note that, you cannot disable a subscription for `REQUIRED` notification type.
- `notification_type` 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
- `integrations` GlobalObjectReference[], required — Integrations to which notifications are to be sent.
- `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
## 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)