Rename IP List

POST https://proxy-sale.com/personal/api/v1/{apiKey}/resident/list/rename

This endpoint allows you to rename an existing IP list within your residential proxy package. Renaming an IP list can help you better organize and identify your lists based on their purpose or content.

Headers

Name	Value
Accept	application/json
Content-Type	application/json

Path parameters

Name	Type	Description
apiKey*	string	API key to authorize requests

Body parameters

Name	Type	Description
id*	integer	The unique identifier of the IP list you want to rename.
title*	string	The new name you wish to assign to the IP list.

Request examples

cURL

curl -X 'POST' \
  'https://proxy-sale.com/personal/api/v1/YOUR_API_KEY/resident/list/rename' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 3350393,
  "title": "US Washington Garfield FIRST-STEP"
}'

PHP

<?php
$apiKey = 'YOUR_API_KEY'; // Replace with your actual API key
$url = 'https://proxy-sale.com/personal/api/v1/' . $apiKey . '/resident/list/rename';
$data = [
  'id' => 3350393,
  'title' => 'US Washington Garfield FIRST-STEP'
];

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode($data),
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    'accept: application/json'
  ],
]);

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class RenameIPListExample {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        String requestBody = "{\"id\": 3350393, \"title\": \"US Washington Garfield FIRST-STEP\"}";

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://proxy-sale.com/personal/api/v1/YOUR_API_KEY/resident/list/rename"))
                .header("Content-Type", "application/json")
                .header("accept", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(requestBody))
                .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Response examples

200 (success)

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

200 (error)

{
  "status": "error",
  "data": null,
  "errors": [
    {
      "message": "not-found",
      "code": 404,
      "customData": null
    }
  ]
}