Delete a response
delete_responseDelete one response for good, with its answers. There is no undo. Destructive: it deletes or replaces data, so it is best confirmed with the user first, naming exactly what will change. After an error or a timeout, a read shows whether the change went through, so a blind retry is not needed. NOT_FOUND after a timeout usually means the delete went through.
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": {
"form_id": "<form_id>",
"response_id": "<response_id>"
},
"name": "delete_response"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| form_id | Yes | The form id, from list_forms or get_form. | |
| response_id | Yes | The response id, from list_responses. | |
| workspace_id | No | The workspace this call acts in: an id from list_my_workspaces. Required for a person signed in with several workspaces and for staff of this deployment; optional with an API key or with only one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deleted | Yes | ||
| workspace | Yes | The workspace this call acted in, to compare with the one the user means. |