This guide shows you how to rename a residential list, change its rotation, or delete it.
Every request uses your personal API key from your account dashboard (how to get your API key). In the examples below, replace YOUR_API_KEY with your own key. To pay from your account balance, use paymentId = 1.
Step 1 — List the residential lists
List your residential lists and copy the id of the one to manage.
Endpoint
GET https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/lists
Response
{
"status": "success",
"data": [
{ "id": 561, "title": "US Washington", "login": "3c8aa1d4", "rotation": 60 }
],
"errors": []
}
Step 2 — Rename the list
Rename the list by its id and a new title.
Endpoint
POST https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/list/rename
Request body
Name | Type | Description |
id | Number | List id. |
title | String | The new title for the list. |
Response
{
"status": "success",
"data": { "id": 561, "title": "New name" },
"errors": []
}
Step 3 — Change the rotation
Or change the list rotation by its id.
Endpoint
POST https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/list/rotation
Request body
Name | Type | Description |
id | Number | List id. |
rotation | Number | Rotation: |
Response
{
"status": "success",
"data": { "id": 561, "title": "New name" },
"errors": []
}
Step 4 — Or delete the list
Delete the list by its id. This is irreversible.
Endpoint
DELETE https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/list/delete
Request body
Name | Type | Description |
id | Number | List id. |
Response
{
"status": "success",
"data": { "deleted": true },
"errors": []
}