Skip to main content
DELETE
Delete a keyword

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Path Parameters

id
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991

Response

200 response

The keyword was deleted. deletedFeeds/deletedNotifications name the cascade — always present, empty when nothing else was destroyed.

deletedFeeds
object[]
required

Feeds destroyed alongside the keyword, because their filters referenced only it. Empty when nothing cascaded.

deletedNotifications
object[]
required

Notifications destroyed alongside those feeds. Empty when nothing cascaded. A notification cannot outlive the feed it is attached to, so this is a strict consequence of deletedFeeds.

ok
boolean
required