growsurf_bulk_delete_participants
Delete up to 200 GrowSurf participants at once using IDs or emails, permanently removing their referrals and rewards. Check the response summary for per-row statuses.
Instructions
Bulk delete participants from your GrowSurf program in one request. DESTRUCTIVE: deletion is permanent, cannot be undone, and removes the participants' referrals, rewards, commissions, and payout records. 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 — a 200 response can still include NOT_FOUND or ERROR rows, so check the summary. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | No | Target program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Pass the `id` returned by growsurf_create_campaign to configure or operate a program you just created, 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. |