ARNPROXY

Delete only an owned connection list; never the package

POST/account/api/v1/residential/lists/delete
Confirm the operation deliberately

This operation may change a record, balance or service configuration. Read its scope and notes first. After an uncertain result, query the same operation rather than starting another.

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionresidential_management
Acceptapplication/json
Content-Typeapplication/json
Idempotency-Key16–100 letters, digits, _ or -. Persist and reuse the same value for the same operation.

Parameters

NameTypeDescription
Idempotency-Key
headerRequired
string16–100 letters/digits/_/-. Keep the same value for the operation/status; do not reuse with a different body.
list_id
bodyRequired
integerOwned ARNPROXY connection-list record ID, not the supplier list ID.
expected_revision
bodyRequired
stringrevision from this operation’s scope/settings read: 64 lowercase hex characters.
terms
bodyRequired
booleanMust be the JSON boolean true for explicit approval, not the string "true".

Request body

Replace YOUR_/FROM_ placeholders with values from the relevant catalog, quote or scope. Examples leave consent false; only approve a real operation intentionally.

request.json
{
    "list_id": "YOUR_LIST_ID",
    "expected_revision": "FROM_SCOPE_REVISION",
    "terms": false
}

Request example

cURL
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/residential/lists/delete'

Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.

Responses

200Success response
application/json
{
    "ok": true,
    "data": {
        "state": "completed",
        "action": "delete",
        "package_id": 20001,
        "list_id": 30001,
        "reason_code": null,
        "replayed": false,
        "credentials_included": false,
        "gb_purchased": 0,
        "balance_changes": 0,
        "package_expiry_changes": 0,
        "manual_review_required": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Response fields and types
NameTypeDescription
okbooleanSuccess envelope flag; on false inspect error.code.
dataobjectOperation-specific result; examples are illustrative and synthetic.
data.statestringRecord/operation state. accepted is not delivery; completed is not a connection test.
data.actionstringOperation-specific action value; preserve its demonstrated type and consult the behavior notes.
data.package_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.list_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.reason_codestring|nullFixed reason code or null, never raw provider error text.
data.replayedbooleanSaved result for the same operation was returned, not proof of a new debit/action.
data.credentials_includedbooleanWhether this result/key includes or permits sensitive credentials.
data.gb_purchasedintegerTraffic amount; list/settings operations do not purchase traffic.
data.balance_changesintegerReported effect of this operation; an automatic-renewal setting can cause future separate debits.
data.package_expiry_changesintegerOperation-specific package expiry changes value; preserve its demonstrated type and consult the behavior notes.
data.manual_review_requiredbooleanOperation-specific manual review required value; preserve its demonstrated type and consult the behavior notes.
metaobjectRequest correlation and data-source metadata.
meta.request_idstringThis HTTP request’s correlation ID, not an operation key or order ID.
meta.phasestringOperation-specific phase value; preserve its demonstrated type and consult the behavior notes.
meta.sourcestringData source; local records and a live provider lookup are different evidence.

Error response

HTTP 401 · INVALID_API_KEY
{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →

Behavior & important notes

  • Package and list IDs are ARNPROXY record IDs, not upstream package keys or list IDs. A stale package snapshot cannot grant access; refresh it with residential_package_refresh when needed.
  • New lists support login_password or ip_auth. IP-auth lists accept 1–20 unique public IPv4 addresses. Deleting a list does not delete its GB package; only connections using that list are revoked.
  • A timeout/5xx is not proof that a write failed. Use the original Idempotency-Key with its status resource. Do not retry under a new key; GET does not resend the change.
Follow the same operationVerify the list operation with GETs; never resend create/delete →

Search the current language. Close with Esc