Tone docs
API referenceCampaigns

Remove every recipient — replacing the list

Clears the list so you can upload a different one. Only meaningful while the campaign is still a draft.

Open in ClaudeOpen in ChatGPTView as Markdown

Requires the write scope. A key with less gets 403 insufficient_scope.

DELETE
/v1/campaigns/{id}/recipients

Authorization

AuthorizationBearer <token>

Authorization: Bearer tone_live_… or tone_test_…. The prefix IS the environment: a test key reaches only the sandbox, and no request field bridges the two.

In: header

Path Parameters

id*string

The campaign's id.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/campaigns/string/recipients"
{  "data": {    "removed": 0  }}
Was this page helpful?

Hide the campaign from the list. Nothing is deleted, and this route still serves it.

Housekeeping for a finished run. Its calls, recipients and compliance record are all still there.

Every compliance check recorded for this campaign's calls

The audit trail for the whole run: every check that passed, warned or blocked, in the order it ran. This is what a complaint is answered with.