Delete List

Delete a list that is not bound to any agent. Reversible.

Deletes a list. It stops being returned by every endpoint — it is gone as far as the API is concerned — but nothing is destroyed: its members and its membership history are kept, and Restore list brings it back exactly as it was. The companies and people themselves are shared across your workspace and are never deleted either way.

A list that is still bound to one or more agents cannot be deleted — unbind it first (see Update agent, pass watchlist_id: null).

Every workspace starts with three lists it did not create: Tier 1, Tier 2 and Tier 3. They are ordinary lists in every other respect — you can rename them, fill them and empty them — but they cannot be deleted, and archiving one fails the same way.

To take a list out of the way without deleting it, archive it instead: pass archived: true to Update list.

Delete list

DELETE/api/v2/lists/{kind}/{list_id}

Path parameters

ParameterTypeDescription
kindstringList kind: company or profile (matches the list type).
list_idintegerIdentifier of the list. Specific to your environment.

Example request

curl -X DELETE "https://api.getsillage.com/api/v2/lists/company/128" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Example response

{
  "data": { "id": 128 }
}

Errors

StatusDescription
401The API key is missing or invalid.
404The list does not exist in your workspace.
409The list is bound to one or more agents (unbind them first), or it is one of the three default Tier 1/2/3 lists or the employee list, which cannot be deleted.
422Invalid kind or list_id.
429Too many requests.
500An unexpected server error occurred.

On this page