Skip to main content

​
DELETE a List

DELETE /user-api/v1/lists/:id

​
Path Parameters

​
id
string
List ID

​
Query Parameters

​
include
string
Related data to include: contacts, companies

​
Endpoint Example

DELETE /user-api/v1/lists/list_99999?include=contacts

​
Response

{
  "data": {
    "id": "list_99999",
    "name": "Premium VIP Contacts",
    "type": "CONTACT",
    "description": "Updated description for our premium contacts",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T12:45:00Z",
    "contacts": [
      {
        "id": "contact_123",
        "full_name": "John Doe",
        "image_url": "https://example.com/avatar.jpg"
      },
      {
        "id": "contact_999",
        "full_name": "Alice Wilson",
        "image_url": "https://example.com/avatar4.jpg"
      }
    ]
  }
}