@elasticemail/elasticemail-client-ts-axios/examples/functions/deleteList.md

Official ElasticEmail SDK. This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.

# Delete List

This is a guide how to delete a contacts list in an easy way using JavaScript or TypeScript.

*Required Access Level: ModifyContacts*

## What's a list?
Lists are static sets of contacts that can be managed manually. Segments are sets of contacts that dynamically change based on the segment's query.

## Preparation
Create a new TypeScript file `snippet.ts` and open it in editor of your preference eg. Visual Studio Code (https://code.visualstudio.com/)

## Let's dig into the code

Put the below code to your file.

Import classes and interfaces you want to use:

```javascript
import { Coonfiguration, ListsApi } from '@elasticemail/elasticemail-client-ts-axios';
```

Create config including your apikey: 

```javascript
const config = new Configuration({
    apiKey: "YOUR_API_KEY"
});
```

Create an instance of ListsApi that will be used to delete list.

```javascript
const listsApi = new ListsApi(config);
```

Specify list name.

> Find out more by checking our API's documentation: https://elasticemail.com/developers/api-documentation/rest-api#operation/listsByNameDelete

```javascript
const listName = 'Example list' // string
```

Create a function calling `listsByNameDelete` method from the API to delete list. You may include console logs called when response comes back.
In case of error it will display error details, otherwise it will display a success message and chosen details about newly created campaign.

```javascript
const deleteList = (listName: string): void => {
    listsApi.listsByNameDelete(listName).then((response) => {
        console.log('API called successfully.');
        console.log(response.data);
    }).catch((error) => {
        console.error(error);
    });
};
```

And finally, call `deleteList` function with proper arguments: 

```javascript
deleteList(listName);
```


## The whole code to copy and paste:

```javascript
/* Initialization */
import { Configuration, ListsApi } from '@elasticemail/elasticemail-client-ts-axios';

/* Generate and use your API key */

const config = new Configuration({
    apiKey: "YOUR_API_KEY"
});

const listsApi = new ListsApi(config);

const listName = 'Example list' // string

const deleteList = (listName: string): void => {
    listsApi.listsByNameDelete(listName).then((response) => {
        console.log('API called successfully.');
        console.log(response.data);
    }).catch((error) => {
        console.error(error);
    });
};

deleteList(listName)
```