Getting Started

Sections

Update Subscription (POST)

Update a subscription's report payload, schedule event, or notification channels. To change the expiration date, use Renew instead.

Request body example

Request Body

 {
  "application_config": {
    "app": "batch_api_v5",
    "metadata": {
      "request_type": "post",
      "payload": {
        "report_query": { "tables": [{ "vtable": "traffic_and_engagement", "granularity": "monthly", "filters": { "domains": ["similarweb.com"], "countries": ["US", "GB"] }, "metrics": ["all_traffic_visits", "desktop_visits", "mobile_visits"], "start_date": "$date", "end_date": "$date" }] },
        "delivery_information": { "delivery_method": "download_link", "response_format": "csv" }
      }
    }
  },
  "schedule": { "event": "snapshot", "notifications": [ { "type": "webhook", "url": "https://example.com/hooks/sw", "notify_on": ["completed", "failed"] }, { "type": "email", "recipients": ["analytics@example.com"], "notify_on": ["expiring_soon"] } ] },
  "update_message": "Updated notification channels"
}

Response

200 OK

 {
  "message": "Subscription Successfully updated"
}

Header Parameters

api-keystring Required

Your Similarweb Batch API key.

Path Parameters

subscription_idstring Required

The subscription's unique id.

Body Parameters

application_configobject Required

What the subscription runs each time it fires.

Show child attributes

scheduleobject Required

When the subscription runs and how the user is notified.

Show child attributes

update_messagestring

Optional note describing the change.

Response

200 OK

Object

Subscription updated.

Response Attributes

messagestring

Result message.

Sections

Update Subscription (POST)

Request body example

Response

Header Parameters

Path Parameters

Body ParametersExpand all

Response

Response Attributes

Response

Ask an AI

Code with AI

Body Parameters