Purge Desk Data
purge_dataUse this to permanently delete stored data. scope sender deletes every evaluation and the scoreboard row for one sender_domain, which is then required (for example "stripe.com"). scope desk deletes the whole desk: criteria, senders and evaluations. Deletion is immediate and cannot be undone, so confirm the scope with the user before calling. Returns purged true and what was deleted. Errors: scope sender with no sender_domain is refused with invalid_input; send sender_domain or use scope desk. Not for changing criteria; use set_criteria. The desk is the signed-in user's, so send no desk_key.
Example tool call
This call uses example arguments supplied in the tool’s input schema.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"scope": "sender",
"sender_domain": "faststaffing.biz"
},
"name": "purge_data"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | Yes | What to delete: "sender" for one sender's records, or "desk" for the whole desk. Confirm with the user first. | |
| sender_domain | No | Required when scope is "sender": the sender domain to delete, such as "stripe.com". Ignored for scope desk. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | Yes | Day of the call, as YYYY-MM-DD in UTC. | |
| scope | Yes | What was deleted. | |
| purged | Yes | True when the records were deleted. | |
| source | Yes | Where the data comes from: the user's own private desk. | |
| message | Yes | Plain statement of what was deleted. |