---
title: "Update Subscription"
method: PUT
path: "/api/v1/user/subscriptions/{subscriptionId}/"
tags: ["Subscriptions"]
---

# Update Subscription

`PUT /api/v1/user/subscriptions/{subscriptionId}/`

Update the settings for a subscription.

## Path parameters

- `subscriptionId` string, required

## Request body

- SubscriptionRequest
  - `subscription` object, required
    - `searchIds` string[], required — Array of search IDs associated with this subscription.
    - `frequency` 'live' | 'hourly' | 'daily', required — Frequency of notifications.
    - `emailAddresses` string[], required — Email addresses receiving the notifications.
    - `name` string, required — Name of the subscription.
    - `description` string — Description of the subscription.
    - `isActive` boolean, required — Whether the subscription is active.
    - `ignoreTime` boolean, required — Whether to ignore time constraints.
    - `weekDays` string[] — Days of the week alerts will be generated.
    - `permissions` string[]
    - `channelIds` string[] — Array of channel IDs associated with this subscription.
    - `incidentChannelIds` string[] — Array of incident channel IDs associated with this subscription.
    - `incidentProfileId` string — Incident Profile ID associated with this subscription.
    - `incidentVisibility` 'unlisted' | 'private' — Incident visibility for this subscription.
    - `incidentCreationMode` 'none' | 'default' | 'always' | 'ignore-if-exists' — Incident creation rule for this subscription.
    - `incidentWatchKeys` 'scans/page.url' | 'scans/page.domain' | 'scans/page.ip' | 'scans/page.apexDomain' | 'hostnames/hostname' | 'hostnames/domain' — Source/key to watch in the incident.

## Response `200`

OK

- SubscriptionResponse
  - `subscription` Subscription
    - `searchIds` string[] — Array of search IDs associated with this subscription.
    - `frequency` 'live' | 'hourly' | 'daily' — Frequency of notifications.
    - `emailAddresses` string[] — Email addresses receiving the notifications.
    - `name` string — Name of the subscription.
    - `description` string — Description of the subscription.
    - `isActive` boolean — Whether the subscription is active.
    - `ignoreTime` boolean — Whether to ignore time constraints.
    - `weekDays` string[] — Days of the week alerts will be generated.
    - `permissions` string[]
    - `channelIds` string[] — Array of channel IDs associated with this subscription.
    - `incidentChannelIds` string[] — Array of incident channel IDs associated with this subscription.
    - `incidentProfileId` string — Incident Profile ID associated with this subscription.
    - `incidentVisibility` 'unlisted' | 'private' — Incident visibility for this subscription.
    - `incidentCreationMode` 'none' | 'default' | 'always' | 'ignore-if-exists' — Incident creation rule for this subscription.
    - `incidentWatchKeys` 'scans/page.url' | 'scans/page.domain' | 'scans/page.ip' | 'scans/page.apexDomain' | 'hostnames/hostname' | 'hostnames/domain' — Source/key to watch in the incident.

---

[API](https://skmtc.net/urlscan/apis/urlscan-io-apis.md) · [All operations](https://skmtc.net/urlscan/apis/urlscan-io-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/urlscan/urlscan-io-apis/versions/5d97b31afd68/schema)