Skip to main content
Update a stream subscription description, event types, transport, or status
Audience: application and admin.

Canonical metadata

  • requestId
  • traceparent

Example request

curl -X PATCH \
  -H "Authorization: Bearer $SECAPI_BEARER_TOKEN" \
  -H "secapi-version: 2026-03-19" \
  -H "content-type: application/json" \
  -d '{"description":"Monitor matches polling stream","eventTypes":["monitor.match","webhook.test"],"transport":"poll","status":"active"}' \
  "https://api.secapi.ai/v1/stream_subscriptions/strm_example_123"

Example response

{
  "object": "stream_subscription",
  "id": "strm_2ZK8Q1W9F4M6P7R3",
  "createdAt": "2026-06-25T15:00:00.000Z",
  "updatedAt": "2026-06-25T15:00:00.000Z",
  "livemode": false,
  "orgId": "org_example_123",
  "description": "Monitor matches polling stream",
  "eventTypes": [
    "monitor.match",
    "webhook.test"
  ],
  "transport": "poll",
  "status": "active",
  "cursor": null,
  "lastEventAt": null,
  "requestId": "req_2ZK8Q1W9F4M6P7R3"
}

Give this prompt to your agent

Failure posture

  • treat non-2xx responses as contract-aware failures, not free-form errors
  • preserve requestId and traceparent in logs and downstream reports
  • if provenance or freshness metadata is present, return it unchanged so trust is not lost in the handoff