Update Addresses in Address Set

PATCH

API for adding and removing addresses of an Address Set via an add/remove batch. To replace the entire address list at once, use the Import Addresses into Address Set API (CSV overwrite).Up to 1,000 addresses can be sent per request across add and remove combined; exceeding this returns 422 ADDRESS_LIMIT_EXCEEDED. The total addresses in a set cannot exceed the plan limit (up to 5,000,000). Every address must match the set's addressFormat. Address change requests for the same set must be spaced out; if the rate limit is hit, retry after retryAfterSeconds from the 429 response.If the same address is included in both add and remove, nothing happens to that address, and it is counted in both skipped and notFound in the response.

Path Parameters

addressSetIdstringrequired

Parameter that specifies the addressSetId assigned to the Address Set. Use the addressSetId returned when the Address Set was created. It is a 19-digit number but is returned as a string in JSON. Parsing it as a number in JavaScript or similar environments loses precision, so always handle it as a string.

Request Body

addarray

List of addresses to add.

removearray

List of addresses to remove.

Responses

addedintegerrequired

Number of addresses actually added.

skippedintegerrequired

Number of add items not added. Counts addresses already in the set and addresses included in both add and remove, to which nothing happened.

removedintegerrequired

Number of addresses actually removed.

notFoundintegerrequired

Number of remove items not removed. Counts addresses not in the set and addresses included in both add and remove, to which nothing happened.

totalCountintegerrequired

Total number of addresses in the set after applying the change.

codestringrequired

Code identifying the cause of the failed request.

messagestringrequired

Detailed message including the name and value of the invalid parameter.

{
  "code": "MISSING_REQUIRED_PARAMETER",
  "message": "Either add or remove must contain at least one address."
}

X-API-KEY

cURL

curl -X PATCH 'https://web3.nodit.io/v1/webhook/address-sets/1788439512345678901/addresses' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "add": [
      "0xabc0000000000000000000000000000000000001",
      "0xabc0000000000000000000000000000000000002"
    ],
    "remove": [
      "0xdef0000000000000000000000000000000000009"
    ]
  }'