---
title: "Update a subscription"
method: PUT
path: "/v1/projects/{projectID}/subscriptions/{subscriptionID}"
tags: ["Subscriptions"]
---

# Update a subscription

`PUT /v1/projects/{projectID}/subscriptions/{subscriptionID}`

This endpoint updates a subscription

## Path parameters

- `projectID` string, required
- `subscriptionID` string, required

## Request body

- ModelsUpdateSubscription
  - `alert_config` ModelsAlertConfiguration
    - `count` integer
    - `threshold` string
  - `app_id` string
  - `endpoint_id` string
  - `filter_config` ModelsFilterConfiguration
    - `event_types` string[]
    - `filter` ModelsFS
      - `body` DatastoreM
      - `headers` DatastoreM
  - `function` string
  - `name` string
  - `rate_limit_config` ModelsRateLimitConfiguration
    - `count` integer
    - `duration` integer
  - `retry_config` ModelsRetryConfiguration
    - `duration` string
    - `interval_seconds` integer
    - `retry_count` integer
    - `type` 'linear' | 'linear' | 'exponential'
  - `source_id` string

## Changes

- **2023-11-17** (v3) `41d4fca4cab8` — 1 warning, 3 info
  - added the new `kafka` enum value to the `allOf[subschema #2]/data/source_metadata/pub_sub/type` response property for the response status `200`
  - added the new optional request property `function`
  - added the optional property `allOf[subschema #2]/data/function` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/data/source_metadata/pub_sub/kafka` to the response with the `200` status
- **2023-07-28** (v3) `2fc887538896` — 1 warning
  - removed the optional property `allOf[subschema #2]/data/source_metadata/idempotency_ttl` from the response with the `200` status
- **2023-06-22** (v3) `5c862889f0b4` — 2 info
  - added the optional property `allOf[subschema #2]/data/source_metadata/idempotency_keys` to the response with the `200` status
  - added the optional property `allOf[subschema #2]/data/source_metadata/idempotency_ttl` to the response with the `200` status

[Change history](https://skmtc.dev/getconvoy/apis/convoy-api-reference/changes/v1/projects/:projectID/subscriptions/:subscriptionID/put.md)

---

[API](https://skmtc.dev/getconvoy/apis/convoy-api-reference.md) · [All operations](https://skmtc.dev/getconvoy/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getconvoy/convoy-api-reference/revisions/bbe11224b60e/schema)