> ## Documentation Index
> Fetch the complete documentation index at: https://docs.secapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# PATCH /v1/stream_subscriptions/{stream_id}

> Update a stream subscription description, event types, transport, or status

Update a stream subscription description, event types, transport, or status

<Info>
  Audience: application and admin.
</Info>

## Canonical metadata

* `requestId`
* `traceparent`

## Example request

<RequestExample>
  ```bash theme={null}
  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"
  ```
</RequestExample>

## Example response

<ResponseExample>
  ```json theme={null}
  {
    "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"
  }
  ```
</ResponseExample>

## Give this prompt to your agent

<Prompt>
  Use SEC API PATCH /v1/stream\_subscriptions/{stream_id} to update a stream subscription description, event types, transport, or status. Preserve `requestId`, `traceparent` in the output. Return a concise markdown summary plus the exact structured payload fields that a downstream engineer or agent should keep using this result.
</Prompt>

## 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