Delete a List

Introduction

The Delete a List endpoint deletes a List for good: its members, the data the List stored for them and its Pending Intake. Export the List first with Export a List if you need to keep a copy. To take some members out and keep the List, use Remove members.

Deleting a List is free (0 credits). While an import is queued, running or paused on the List, while the lines of a cancelled import still wait for their result, or while a Search of the app is still adding people to it, the request returns 409 LIST_BUSY: wait for the import to end, or cancel it and wait for its last results, then delete again.

The API key needs the lists permission (see API key management).

Authorization

Request

The route is DELETE /v2/lists/:listId.

Path parameters

The request has no body.

Response structure

quotas and metadata are the blocks of every V2 response: see Usage.

Errors

Code examples

curl -X DELETE https://api.reversecontact.com/v2/lists/3f6c2a8e-1b4d-4f0a-9c7e-5d2b8a1e6f40 \
  -H "Authorization: Bearer YOUR_API_KEY"

const listId = "3f6c2a8e-1b4d-4f0a-9c7e-5d2b8a1e6f40";
const response = await fetch(`https://api.reversecontact.com/v2/lists/${listId}`, {
  method: "DELETE",
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});

console.log("Deleted:", (await response.json()).data.deleted);

import requests

list_id = "3f6c2a8e-1b4d-4f0a-9c7e-5d2b8a1e6f40"
response = requests.delete(
    f"https://api.reversecontact.com/v2/lists/{list_id}",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)

print("Deleted:", response.json()["data"]["deleted"])

Example response

{
  "success": true,
  "data": {
    "deleted": true
  },
  "error": null,
  "quotas": {
    "creditsConsumed": 0,
    "workspace": {
      "id": "ws_abc123",
      "credits": { "total": 10000, "used": 4521, "left": 5479 }
    }
  },
  "metadata": {
    "requestId": "req_d1e2l3e4t5e6",
    "executionTimeMs": 61
  }
}