Skip to content

DELETE /v3/search/subscriptions/{id}

Delete a search subscription.

API key: required. See Authentication.

Group: Webhooks (API: callbacks)

Parameters

NameInTypeRequiredDefaultDescription
idpathstringyesThe subscription's id (sub_ and 24 hex digits).

Responses

StatusBodyDescription
204noneDone; no body.
400Problem (application/problem+json)Invalid or unknown parameter, or a query error (invalid_query, query_too_complex, prefix_too_broad, negative_only_query, unsupported_operator, invalid_cursor); query errors carry position and length (characters of q).
401Problem (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).
403Problem (application/problem+json)The credential's scope does not cover this route (code forbidden).
404Problem (application/problem+json)Not found.
409Problem (application/problem+json)Conflict with the current state.
503Problem (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.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 204 carries no body.

Example request

Shell
curl -sS -X DELETE -H "Authorization: Bearer $SECBLAST_API_KEY" \
  'https://api.secblast.com/v3/search/subscriptions/sub_0123456789abcdef01234567'

More in Webhooks (API: callbacks)

Previous: PATCH /v3/search/subscriptions/{id} · Next: POST /v3/search/subscriptions/{id}/test

Markdown version: /docs/reference/delete-search-subscriptions-id.md