Bulk Delete Participants
growsurf_bulk_delete_participantsPermanently delete up to 200 GrowSurf participants by ID or email in one request, with per-row results for deleted, not-found, duplicate, and error outcomes.
Instructions
Bulk delete participants from your GrowSurf program in one request. DESTRUCTIVE: deletion is permanent and cannot be undone. Successful rows lose participant access immediately; related record cleanup completes automatically, subject to required financial record retention. Each entry in participants is a GrowSurf participant ID or an email address (mixed lists are allowed), up to 200 entries per request — chunk larger lists across multiple calls. Returns a summary (total, deletedCount, notFoundCount, duplicateCount, errorCount) plus per-row results in request order, each with status DELETED, NOT_FOUND, DUPLICATE (resolves to the same participant as an earlier entry), or ERROR — both 200 and 202 responses can include NOT_FOUND or ERROR rows, and the summary reports these outcomes. A 202 response includes analyticsErasure when analytics erasure is pending. DELETED means participant access was removed; reports can retain the participant until cleanup completes. Do not repeat successful rows to finish cleanup. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
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": {
"participants": "<participants>",
"campaignId": "<campaignId>"
},
"name": "growsurf_bulk_delete_participants"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | Yes | Target program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server. | |
| participants | Yes | GrowSurf participant IDs and/or email addresses to delete (1-200 entries; mixed lists allowed). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| results | No | One entry per submitted identifier, in request order. | |
| summary | No | Counts across all submitted entries. | |
| analyticsErasure | No | Analytics erasure is pending. Reports can retain removed participants until erasure completes. Do not repeat successful deletions. |