# Create Subscription

Create a new subscription.

Endpoint: POST /api/v1/user/subscriptions/
Version: 1.0.0
Security: apikeyAuth

## Request fields (application/json):

  - `subscription` (object, required)
    Example: {"searchIds":["{{searchId}}"],"frequency":"daily","emailAddresses":["test@urlscan.io"],"name":"Test Subscription","description":"Subscription for testing purposes","isActive":true,"ignoreTime":false}

  - `subscription.searchIds` (array, required)
    Array of search IDs associated with this subscription.
    Example: ["{{searchId}}"]

  - `subscription.frequency` (string, required)
    Frequency of notifications.
    Enum: "live", "hourly", "daily"

  - `subscription.emailAddresses` (array, required)
    Email addresses receiving the notifications.
    Example: ["test@urlscan.io"]

  - `subscription.name` (string, required)
    Name of the subscription.
    Example: "Test Subscription"

  - `subscription.description` (string)
    Description of the subscription.
    Example: "Subscription for testing purposes"

  - `subscription.isActive` (boolean, required)
    Whether the subscription is active.
    Example: true

  - `subscription.ignoreTime` (boolean, required)
    Whether to ignore time constraints.

  - `subscription.weekDays` (array)
    Days of the week alerts will be generated.
    Enum: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"

  - `subscription.permissions` (array)
    Enum: "team:read", "team:write"

  - `subscription.channelIds` (array)
    Array of channel IDs associated with this subscription.

  - `subscription.incidentChannelIds` (array)
    Array of incident channel IDs associated with this subscription.

  - `subscription.incidentProfileId` (string)
    Incident Profile ID associated with this subscription.

  - `subscription.incidentVisibility` (string)
    Incident visibility for this subscription.
    Enum: "unlisted", "private"

  - `subscription.incidentCreationMode` (string)
    Incident creation rule for this subscription.
    Enum: "none", "default", "always", "ignore-if-exists"

  - `subscription.incidentWatchKeys` (string)
    Source/key to watch in the incident.
    Enum: "scans/page.url", "scans/page.domain", "scans/page.ip", "scans/page.apexDomain", "hostnames/hostname", "hostnames/domain"

## Response 200 fields (application/json):

  - `subscription` (object)
    Example: {"_id":"{{subscriptionId}}","searchIds":["{{searchId}}"],"frequency":"daily","emailAddresses":["test@urlscan.io"],"name":"Test Subscription","description":"Subscription for testing purposes","isActive":true,"ignoreTime":false}

  - `subscription._id` (string)
    Subscription ID
    Example: "{{subscriptionId}}"

  - `subscription.searchIds` (array)
    Array of search IDs associated with this subscription.
    Example: ["{{searchId}}"]

  - `subscription.frequency` (string)
    Frequency of notifications.
    Enum: same as `subscription.frequency` (3 values)

  - `subscription.emailAddresses` (array)
    Email addresses receiving the notifications.
    Example: ["test@urlscan.io"]

  - `subscription.name` (string)
    Name of the subscription.
    Example: "Test Subscription"

  - `subscription.description` (string)
    Description of the subscription.
    Example: "Subscription for testing purposes"

  - `subscription.isActive` (boolean)
    Whether the subscription is active.
    Example: true

  - `subscription.ignoreTime` (boolean)
    Whether to ignore time constraints.

  - `subscription.weekDays` (array)
    Days of the week alerts will be generated.
    Enum: same as `subscription.weekDays` (7 values)

  - `subscription.permissions` (array)
    Enum: same as `subscription.permissions` (2 values)

  - `subscription.channelIds` (array)
    Array of channel IDs associated with this subscription.

  - `subscription.incidentChannelIds` (array)
    Array of incident channel IDs associated with this subscription.

  - `subscription.incidentProfileId` (string)
    Incident Profile ID associated with this subscription.

  - `subscription.incidentVisibility` (string)
    Incident visibility for this subscription.
    Enum: same as `subscription.incidentVisibility` (2 values)

  - `subscription.incidentCreationMode` (string)
    Incident creation rule for this subscription.
    Enum: same as `subscription.incidentCreationMode` (4 values)

  - `subscription.incidentWatchKeys` (string)
    Source/key to watch in the incident.
    Enum: same as `subscription.incidentWatchKeys` (6 values)