## Delete a list `list.delete(strid, ListDeleteParams**kwargs) -> ListDeleteResponse` **delete** `/v1/lists/{id}` Moves a list to the trash. The list is soft-deleted and may be restored from the Lightfield UI. Member entities (accounts, contacts, or opportunities) are not affected. Calling delete on an already-trashed list is a no-op and returns the existing record. **[Required scope](/using-the-api/scopes/):** `lists:delete` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id: str` Unique identifier of the list to delete. - `body: Optional[Body]` ### Returns - `class ListDeleteResponse: …` - `id: str` Unique identifier for the list. - `created_at: str` ISO 8601 timestamp of when the list was created. - `fields: Dict[str, Fields]` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$objectType`). - `value: Optional[FieldsValue]` The field value, or null if unset. - `str` - `float` - `bool` - `List[str]` - `class FieldsValueAddress: …` - `city: Optional[str]` City name. - `country: Optional[str]` 2-letter ISO 3166-1 alpha-2 country code. - `latitude: Optional[float]` Latitude coordinate. - `longitude: Optional[float]` Longitude coordinate. - `postal_code: Optional[str]` Postal or ZIP code. - `state: Optional[str]` State or province. - `street: Optional[str]` Street address line 1. - `street2: Optional[str]` Street address line 2. - `class FieldsValueFullName: …` - `first_name: Optional[str]` The contact's first name. - `last_name: Optional[str]` The contact's last name. - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 12 more]` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `"HTML"` - `http_link: Optional[str]` URL to view the list in the Lightfield web app, or null. ### Example ```python from lightfield import Lightfield client = Lightfield( api_key="My API Key", ) list_delete_response = client.list.delete( id="id", ) print(list_delete_response.id) ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink" } ```