> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.heyreach.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.heyreach.io/_mcp/server.

# CreateEmptyList

POST https://api//api/public/list/CreateEmptyList
Content-Type: application/json

Create an empty lead or company list. You pass the list name and the list type (**USER_LIST** or **COMPANY_LIST**). If the type value is left empty, a Lead list will be created by default.

Reference: https://docs.heyreach.io/hey-reach-api/lists/create-empty-list

## Request

### Headers

- `X-API-KEY` (string, optional) — API key header using this scheme. Example: "X-API-KEY: \{API\_KEY}"

### Body (application/json)

This endpoint expects an object.

- `name` (string, required)
- `type` (string, required)

## Response

### 200

OK

- `id` (integer, required)
- `name` (string, required)
- `count` (integer, required)
- `listType` (string, required)
- `creationTime` (datetime, required)
- `isDeleted` (boolean, required)
- `status` (string, required)
- `campaigns` (any, optional, nullable)
- `search` (any, optional, nullable)

## Errors

### 400 Create Empty List Lists Request Bad Request Error

Bad Request

- `errorMessage` (string, required)

### 401 Create Empty List Lists Request Unauthorized Error

Unauthorized

- `type` (string, required)
- `title` (string, required)
- `status` (string, required)
- `detail` (string, required)
- `instance` (string, required)
- `ut8c` (object, required)
- `laborum__e5` (object, required)
- `occaecat100` (object, required)

### 404 Create Empty List Lists Request Not Found Error

Not Found

- `errorMessage` (string, required)

### 429 Create Empty List Lists Request Too Many Requests Error

Too Many Requests

- `type` (string, required)
- `title` (string, required)
- `status` (string, required)
- `detail` (string, required)
- `instance` (string, required)
- `ut8c` (object, required)
- `laborum__e5` (object, required)
- `occaecat100` (object, required)

## Examples

**Request**

```json
{
  "name": "<string>",
  "type": "<COMPANY_LIST|USER_LIST>"
}
```

**Response**

```json
{
  "id": 123,
  "name": "My List",
  "count": 0,
  "listType": "<COMPANY_LIST|USER_LIST>>",
  "creationTime": "2024-08-29T09:34:56Z",
  "isDeleted": false,
  "status": "UNKNOWN"
}
```

**SDK Code**

```python
import requests

url = "https://api//api/public/list/CreateEmptyList"

payload = {
    "name": "<string>",
    "type": "<COMPANY_LIST|USER_LIST>"
}
headers = {
    "X-API-KEY": "<string>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api//api/public/list/CreateEmptyList';
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<string>', 'Content-Type': 'application/json'},
  body: '{"name":"<string>","type":"<COMPANY_LIST|USER_LIST>"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api//api/public/list/CreateEmptyList"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"type\": \"<COMPANY_LIST|USER_LIST>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<string>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api//api/public/list/CreateEmptyList")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<string>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"type\": \"<COMPANY_LIST|USER_LIST>\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api//api/public/list/CreateEmptyList")
  .header("X-API-KEY", "<string>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"type\": \"<COMPANY_LIST|USER_LIST>\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api//api/public/list/CreateEmptyList', [
  'body' => '{
  "name": "<string>",
  "type": "<COMPANY_LIST|USER_LIST>"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-API-KEY' => '<string>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api//api/public/list/CreateEmptyList");
var request = new RestRequest(Method.POST);
request.AddHeader("X-API-KEY", "<string>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"<string>\",\n  \"type\": \"<COMPANY_LIST|USER_LIST>\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-API-KEY": "<string>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "<string>",
  "type": "<COMPANY_LIST|USER_LIST>"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/list/CreateEmptyList")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```