Skip to content
API Endpoints/
/
Update Subscription

Update Subscription

Request

Update the settings for a subscription.

Security
apikeyAuth(Required scopes: readwrite)
Path
subscriptionIdstringrequired
Example:{{subscriptionId}}
Bodyapplication/json
subscriptionobject(subscription)required
Example:
{
  "searchIds": [
    "{{searchId}}"
  ],
  "frequency": "daily",
  "emailAddresses": [
    "test@urlscan.io"
  ],
  "name": "Test Subscription",
  "description": "Subscription for testing purposes",
  "isActive": true,
  "ignoreTime": false
}
PUT
/api/v1/user/subscriptions/{subscriptionId}/
curl -i -X PUT \
  'https://urlscan.io/api/v1/user/subscriptions/{{subscriptionId}}/' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "subscription": {
      "searchIds": [
        "{{searchId}}"
      ],
      "frequency": "daily",
      "emailAddresses": [
        "test@urlscan.io"
      ],
      "name": "Test Subscription",
      "description": "Subscription for testing purposes",
      "isActive": true,
      "ignoreTime": false
    }
  }'

Responses

OK

Bodyapplication/json
subscriptionobject(subscription)
Example:
{
  "_id": "{{subscriptionId}}",
  "searchIds": [
    "{{searchId}}"
  ],
  "frequency": "daily",
  "emailAddresses": [
    "test@urlscan.io"
  ],
  "name": "Test Subscription",
  "description": "Subscription for testing purposes",
  "isActive": true,
  "ignoreTime": false
}
Response
{
  "subscription": {
    "_id": "{{subscriptionId}}",
    "searchIds": [ … ],
    "frequency": "daily",
    "emailAddresses": [ … ],
    "name": "Test Subscription",
    "description": "Subscription for testing purposes",
    "isActive": true,
    "ignoreTime": false
  }
}