Pause, resume, or retire a keyword
keyword_manageManage a keyword's lifecycle across every Source at once: pause stops all its polling and all its spending, resume restarts it, delete retires it and frees the plan slot. Free — does not charge credits. Pausing is also how you stop the polling that does. On resume, a Source an operator stopped stays stopped and comes back named in blockedSources rather than failing the call: read that field before reporting success. delete takes an optional purge: without it the mentions the keyword caught stay readable, with purge=true they are deleted too and cannot be recovered. Ask before pausing or deleting, and ask again before purging: this is the customer's monitoring and the mentions are the record of what it found.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Keyword id, from list_keywords. Another account's id is a 404, never a 403. | |
| purge | No | Only with action=delete. true also deletes every mention the keyword collected, with its readings, marks and replay entries. The keyword itself stays readable by id. Omitted or false is the default retire: the mentions stay readable until retention ages them out. This erases the customer's collected data and is not reversible, so ask before sending it. Credits are not refunded either way. | |
| action | Yes | pause stops every Source: nothing polls, charges or delivers, and the mentions already caught stay readable. resume restarts every Source that can follow. delete retires the keyword and frees the plan slot; it is not a hard delete, so the keyword and its mentions stay readable. |