# Create list

### **Endpoint:**

<mark style="color:yellow;">`POST`</mark> `https://proxy-seller.com/personal/api/v1/{YourApiKey}/resident/list/add`

#### **Example:**

```
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/resident/list/add
```

### **Response:**

{% tabs %}
{% tab title="200: OK Success response " %}

```json
{
  "status": "success",
  "data": {
    "id": 561,
    "title": "US Washington Garfield FIRST-STEP",
    "login": "3c8aa1d4",
    "password": "AZT62Dx3",
    "whitelist": "127.0.0.1,192.168.0.1",
    "rotation": "-1 = sticky, 0 = rotation per request, 1..3600 time in seconds",
    "geo": {
      "country": "US",
      "region": "Washington",
      "city": "Garfield",
      "isp": "FIRST-STEP"
    },
    "export": {
      "ports": 10000,
      "ext": "txt"
    }
  },
  "errors": []
}
```

{% endtab %}

{% tab title="200: OK Error response Wrong API key" %}

```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Error api key",
            "code": 503,
            "customData": null
        },
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        },
        {
            "message": "Request limit reached",
            "code": 503,
            "customData": null
        }
    ]
}
```

{% endtab %}

{% tab title="200: OK Error response Wrong authorization IP" %}

```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        }
    ]
}
```

{% endtab %}

{% tab title="200: OK Error response Tarif not found" %}

```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Tarif not found",
            "code": 0,
            "customData": null
        }
    ]
}
```

{% endtab %}
{% endtabs %}

### **Responses with error in body request:**

{% tabs %}
{% tab title="200: OK Error response Incorrect whitelist IP" %}

```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Incorrect IP address 0.0.0.0 entered",
            "code": 409,
            "customData": null
        }
    ]
}
```

{% endtab %}

{% tab title="200: OK Error response IP already linked" %}

```json
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "IP 127.0.0.1 already linked",
            "code": 0,
            "customData": null
        }
    ]
}
```

{% endtab %}

{% tab title="200: OK Error response Invalid country code" %}

```json
Same error may be in case with wrong "region", "city", "isp"!
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Invalid country (region,  city, isp) ISO code",
            "code": 400,
            "customData": null
        },
        {
            "message": "Invalid country ISO code (400)",
            "code": 0,
            "customData": null
        }
    ]
}
```

{% endtab %}
{% endtabs %}

### Path parameter&#x73;**:**

<table data-full-width="false"><thead><tr><th width="149">Name</th><th width="189">Value</th><th>Description</th><th data-hidden></th></tr></thead><tbody><tr><td>Authorization</td><td><code>&#x3C;Your_API_Key></code></td><td>Your personal API key</td><td></td></tr></tbody></table>

### **Request body:**

<table><thead><tr><th width="113">Name</th><th width="96">Type</th><th>Description</th></tr></thead><tbody><tr><td>title</td><td>String</td><td>Name of the list you are creating</td></tr><tr><td>whitelist</td><td>String</td><td>IPs for authorization. Leave blank if you want to authorize with login credentials</td></tr><tr><td></td><td></td><td></td></tr><tr><td>geo</td><td><strong>object</strong></td><td>Add GEO data to your list (country, region, city, ISP)</td></tr><tr><td>country</td><td>String</td><td>Country selected from the <a href="get-all-locations">GEO database</a> <strong>(Case is important)</strong></td></tr><tr><td>region</td><td>String</td><td>Region selected from the <a href="get-all-locations">GEO database</a> <strong>(Case is important)</strong></td></tr><tr><td>city</td><td>String</td><td>City selected from the <a href="get-all-locations">GEO database</a> <strong>(Case is important)</strong></td></tr><tr><td>isp</td><td>String</td><td>ISP selected from the <a href="get-all-locations">GEO database</a> <strong>(Case is important)</strong></td></tr><tr><td></td><td></td><td></td></tr><tr><td><strong>export</strong></td><td><strong>object</strong></td><td>Here you specify the number of IPs in your list and the export type (port numbers and file format).</td></tr><tr><td>ports</td><td>Number</td><td>Number of IPs (maximum 1000)</td></tr><tr><td>ext</td><td>String</td><td>Type of export</td></tr><tr><td></td><td></td><td></td></tr><tr><td>rotation</td><td>Number</td><td>"rotation: '-1' for no rotation (Sticky), '0' for rotation per request, '1' to '3600' for time-based rotation in seconds</td></tr></tbody></table>