v1

latestOpenAPI 3.0.02026-08-065019221.4 KB

Subscriptions

Update Subscription

Update the settings for a subscription.

put/api/v1/user/subscriptions/{subscriptionId}/

Path parameters

subscriptionIdstring required

Request body

Example request

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

Response

Example response

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