Delete responses

Deletes one response of a form, and its webhook deliveries.

DELETE /v1/form/forms/{id}/responses/{response}

Addresshttps://api.hanzo.ai/v1/form/forms/{id}/responses/{response}
MethodDELETE
Operationdelete_form_response
AuthAuthorization: Bearer $HANZO_API_KEY

Deletes one response of a form, and its webhook deliveries. What the sinks already hold (the CRM's timeline, a webhook's receiver) is theirs. An org admin only.

Request

2 fields.

FieldInTypeRequiredDescription
idpathstringyesID is the form's id or slug, from the path.
responsepathstringyesResponse is the response's id, from the path.

Response

StatusBodyMeaning
204—no content
defaultproblem-detailsrefused

Failure carries the platform error shape — see Errors.

Examples

hanzo form forms responses rm <id> <response>
import { Configuration, FormApi } from 'hanzoai';

const api = new FormApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.deleteFormResponse({ id: 'id', response: 'response' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FormApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FormApi(client).delete_form_response(id='id', response='response')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FormAPI.DeleteFormResponse(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, form_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = form_api::delete_form_response(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FormApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FormApi(client).deleteFormResponse();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X DELETE https://api.hanzo.ai/v1/form/forms/<id>/responses/<response> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool form, op delete_form_response — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "form",
         "arguments": {
           "op": "delete_form_response",
           "input": {
             "id": "<id>",
             "response": "<response>"
           }
         }
       }
     }'

Form API · All Hanzo APIs · Interactive reference

Was this page useful?
Broken link or missing step? Drop it in #docs on Discord or open a PR.