PATCH /v3/search/subscriptions/{id}
Change a search subscription.
API key: required. See Authentication.
Group: Webhooks (API: callbacks)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
id | path | string | yes | The subscription's id (sub_ and 24 hex digits). |
Request body
A SearchSubscriptionPatch object, as JSON.
| Field | Type | Required | Description |
|---|---|---|---|
active | boolean | no | true on an inactive subscription counts against its kind's limit. |
endpoint_id | string | no | |
include_corrections | boolean | no | |
min_interval_s | integer | null | no | null clears it. |
name | string | no | |
query | object | no | Replaces the stored query whole. |
Responses
| Status | Body | Description |
|---|---|---|
200 | SearchSubscription (application/json) | OK |
400 | Problem (application/problem+json) | Invalid or unknown parameter, or a body that is not one JSON document (code invalid_body). |
401 | Problem (application/problem+json) | Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728). |
403 | Problem (application/problem+json) | The credential's scope does not cover this route (code forbidden). |
404 | Problem (application/problem+json) | Not found. |
409 | Problem (application/problem+json) | Conflict with the current state. |
415 | Problem (application/problem+json) | The body is not sent as Content-Type: application/json (code unsupported_media_type). |
503 | Problem (application/problem+json) | Full-text search cannot answer now: search_unavailable (sb_search unreachable or not configured), search_busy (its queue is full), search_timeout (the query hit its time budget), ticker_resolution_unavailable; or the database is unavailable. Retry after the Retry-After delay when one is given. |
default | Problem (application/problem+json) | Any other error (405, 500, 504). |
Response body
A 200 carries a SearchSubscription object.
| Field | Type | Required | Description |
|---|---|---|---|
active | boolean | yes | |
created_at | date-time (RFC 3339, UTC) | yes | |
endpoint_id | string | yes | cbe_ and 24 hex digits. |
id | string | yes | sub_ and 24 hex digits. |
include_corrections | boolean | yes | |
kind | string | yes | From the query: search when q is not empty, or doctypes, primary_only=true or entityName is given; else filing when a filing-level filter is given (forms, form_types, form_families and their exclusions, ciks, tickers, sics, states, inc_states, locationCode, items); else firehose. filing and firehose deliver filing.new, search delivers search.match. A filing subscription counts against limits.filter. Text subscriptions (kind search) are not offered: a create or PATCH whose query has q, doctypes, primary_only=true or entityName is a 400 invalid_parameter naming that parameter. One of: filing, firehose, search. |
min_interval_s | integer | null | yes | Digest interval; null: every event is delivered alone. |
name | string | yes | |
query | object | yes | As stored: q, syntax, match and the structured filters as /v3/search/parse normalises them, tickers resolved into ciks at save time (no tickers member), items as given, accepted_from and accepted_to always null. |
query.filters | object | yes | |
query.match | string | yes | One of: exact, stem. |
query.q | string | yes | |
query.syntax | string | yes | One of: sb, edgar. |
updated_at | date-time (RFC 3339, UTC) | yes |
Example request
curl -sS -X PATCH -H "Authorization: Bearer $SECBLAST_API_KEY" \
-H "Content-Type: application/json" -d @body.json \
'https://api.secblast.com/v3/search/subscriptions/sub_0123456789abcdef01234567'More in Webhooks (API: callbacks)
Previous: GET /v3/search/subscriptions/{id} · Next: DELETE /v3/search/subscriptions/{id}
Markdown version: /docs/reference/patch-search-subscriptions-id.md