Delete responses in bulk

Deletes up to 100 responses in one transaction. Requires manage access to the workspace.

A POST custom method, not a DELETE on the collection. A collection-level DELETE that loses its filters — through a client bug, a proxy stripping a query string, a copied curl command — degrades into erasing every response in scope. A distinct path cannot be reached by accident. AIP-165 blesses batchDelete for exactly this reason.

It scope-filters rather than rejecting. Ids belonging to another workspace, and ids that no longer exist, are ignored; the ids in the caller’s own workspace are deleted and deleted reports how many that was. Rejecting the whole call on a foreign id would do two bad things at once: leak that the id exists somewhere, and break retries — after a partially-applied call, an already-deleted id is indistinguishable from a foreign one. Scope-filtering is idempotent and leaks nothing, so a client can safely retry the same batch.

Because deleted can therefore be lower than the number of ids sent — or zero — do not treat a shortfall as an error. Deletion cascades to uploaded files exactly as the single-response delete does — and, exactly as it does, leaves the Hub copy in place. See that operation for why.

workspaceId is the scope, and it is required. Unlike the single-response delete — which resolves the workspace from the response so a caller cannot pair someone else’s id with a scope it happens to hold — a batch has no single response to resolve from, and scope-filtering is only meaningful against a known workspace. Supplying it is safe here because the same value is both what manage is checked against and what the delete is filtered by: the two cannot diverge, so a foreign id matches nothing rather than being deleted under a scope the caller does hold.

POST /api/v3/responses/batch-delete

Delete responses in bulk

cURL

curl --request POST \
  --url https://app.formbricks.com/api/v3/responses/batch-delete \
  --header 'Content-Type: application/json' \
  --cookie next-auth.session-token= \
  --data '
{
  "ids": [
    "clrs1234567890123456789012",
    "clrs2234567890123456789012",
    "clrs3234567890123456789012"
  ]
}
'

200

{
  "data": {
    "deleted": 1
  }
}

Authorizations

sessionAuthapiKeyAuthbearerAuth

next-auth.session-token · string · cookie · required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Query Parameters

workspaceId · string<cuid2> · required

Workspace identifier. This is the canonical container ID for v3 APIs.

Body

application/json

Ids to delete. A POST custom method rather than a DELETE on the collection: a collection-level DELETE that loses its filters degrades into erasing every response in scope, and a distinct path cannot be reached by accident — which is exactly the shape feedbackRecords ships today, a collection DELETE whose filters are the only thing standing between a caller and the whole dataset. AIP-165 blesses the custom-method form.

ids · string<cuid2>[] · required

Response ids to delete, at most 100 per call.

Required array length: 1 - 100 elements

Response

200

application/json

Batch processed. deleted counts the responses actually removed, which may be fewer than the ids submitted.

data · object · required

Show child attributes