API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.

Delete a list

Remove a list.

Deletes a list. It and its members stop being returned by every endpoint, but nothing is destroyed: Restore a list brings it back exactly as it was. Deleting is refused when the list is the only list of its kind for its persona (for a prospect list, of its tier, such as the only prospect Tier 1 list for this persona), while a signal setup still watches it, and on the "All my employees" list. The list's is_deletable and not_deletable_reason tell you beforehand. Deleting a monitored list stops its monitoring; the month already paid is not refunded. To move a list out of the way without deleting it, archive it with Update a list.

Route

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

Access modes

Use a workspace API key. The workspace is inferred from the key.

Authorization: Bearer sk_live_...

Path parameters

ParameterTypeDescription
kindstringcompany or profile. It matches the kind of the list.
list_idintegerID of the list.

Example request

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

Success response

Status: 200 OK

{
  "data": {
    "id": 12,
    "deleted": true
  }
}

Response fields

FieldTypeDescription
data.idintegerID of the list that was deleted.
data.deletedbooleanAlways true.

Errors

StatusMeaning
401The API key is missing or invalid.
402Your workspace has no active plan (paywall_required). Start your trial or choose a plan at https://www.getsillage.com/paywall, then retry.
404The list does not exist.
409The list is the only list of its kind for its persona (for a prospect list, of its tier), a signal setup or an older app signal still uses it, or it is the "All my employees" list. In use by a signal setup: "List is used by one or more signal setups; delete them before deleting (archiving) the list"; used only by older signals set up in the Sillage app: "List is used by signals set up in the Sillage app; remove them there before deleting (archiving) the list." Last of its kind: "This is the only prospect Tier 1 list for persona "EMEA Sales". Create another one before deleting or archiving it." (a prospect list names its tier, a customer list names none; it names each persona the list is the last one for, or says "that is not attached to a persona").
422kind or list_id is not valid: detail is "Invalid URL parameters" and errors names the parameter.
429Rate limit exceeded.
500An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank; code tells one problem from another, detail says what went wrong this time, and errors names the field at fault.

On this page