Delete a what-if scenario
beyondpayday_delete_scenarioDeletes a saved what-if scenario (the household's real data is untouched). It can be restored for 30 days with beyondpayday_restore_deleted. Get the id from beyondpayday_list_scenarios. Pass the scenario's updated_at as expected_updated_at so a scenario changed since is not deleted. Only the family owner or spouse/partner can do this, with What-if planner update plus income, bills and assets access. Figures are estimates from user-entered data — not tax, financial, investment, insurance, or legal advice.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"scenario_id": "<scenario_id>"
},
"name": "beyondpayday_delete_scenario"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scenario_id | Yes | The scenario id (beyondpayday_list_scenarios). | |
| expected_updated_at | No | The updated_at from your last read of this scenario. If it changed since, the call is refused so you can re-read instead of overwriting someone else's change. |